v1

latestOpenAPI 3.1.02026-07-2083190.2 KB
General

Pay out from an account to the account holder

Pays out a specified amount from an account to the bank account of account holder.

post/payoutAccountHolder

Request body

accountCodestring required

The code of the account from which the payout is to be made.

accountHolderCodestring required

The code of the Account Holder who owns the account from which the payout is to be made. The Account Holder is the party to which the payout will be made.

bankAccountUUIDstring

The unique ID of the Bank Account held by the Account Holder to which the payout is to be made. If left blank, a bank account is automatically selected.

descriptionstring

A description of the payout. Maximum 200 characters. Allowed: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ ";

merchantReferencestring

A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.

Response

OK - the request has succeeded.

bankAccountUUIDstring

The unique ID of the Bank Account to which the payout was made.

merchantReferencestring

The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

resultCodestring

The result code.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

  • true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
  • false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.