ImportPaymentTransactionCommandRequestInput
Delivers one transaction of an external payment account, for example from a payment service the ERP has no connection for. A transaction with the same ‘transactionId’ in the account is updated (its note and whether it is ignored stay); this is how a pending transaction is completed later. Import filters, workflows and the import cutoff date of the account apply as for a fetch; ‘outcome’ tells what happened. When automatic assignment is switched on in the settings, it runs for the delivered transaction afterwards. Errors: PAYMENT_ACCOUNT_NOT_FOUND (the payment account was not found); PAYMENT_ACCOUNT_HIDDEN (the payment account is hidden; show it with ‘ShowPaymentAccount’ first); PAYMENT_ACCOUNT_NOT_EXTERNAL (the account is not an external account; its transactions come from the bank or the payment provider); PAYMENT_TRANSACTION_ASSIGNED (the transaction is assigned or refunded, and the change would alter its amount or its currency, switch its kind to or from Fee, or end it as cancelled, failed or expired); CURRENCY_ISO_CODE_INVALID (the currency is not a three-letter ISO 4217 code). - Request
ImportPaymentTransactionCommandRequestInputFields
The ID of the payment account.
The ID of the transaction in the external system. Unique within the account; delivering it again updates the transaction.
When the transaction was booked.
The amount with at most two decimals: positive for money received, negative for money sent or taken back.
The currency (ISO 4217). Case does not matter; it is stored in upper case.
What the transaction stands for. Defaults to Regular when omitted.
How far it is processed. Defaults to Completed when omitted. A pending transaction is completed by delivering it again.
The name of the payer or the payee.
The account of the payer or the payee: an IBAN, an account number or an email address.
An addition to the account, for example the BIC.
The payment reference. The matching looks for order and invoice numbers in it.
For refunds, chargebacks and fees: the 'transactionId' of the earlier transaction of the same account.
A further reference, for example a mandate or an end-to-end reference.
A status message, for example why a payment failed.
Further information about the transaction.
Whether to suppress the workflows of the import: the event that runs while a transaction is read in (its workflows can refuse or hide the transaction, so with this flag such rules do not apply) and the event after it is saved. Events for other systems are still published. Defaults to false when omitted.
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?