Pay out from an account to the account holder
Pays out a specified amount from an account to the bank account of account holder.
Request Parameters
The code of the account from which the payout is to be made.
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.
An object containing the currency and value of the payout.
If the account has multiple currencies, specify the currency to be used.
If the bankAccountUUID is provided in the request, the currency supported by the bank is used.
If the payoutMethodCode is provided in the request, the specified payout method is selected.
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.
A description of the payout. Maximum 200 characters. Allowed: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ ";
A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
The unique ID of the payout method held by the Account Holder to which the payout is to be made. If left blank, a payout instrument is automatically selected.
Speed with which payouts for this account are processed. Permitted values: STANDARD, SAME_DAY.
Response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
202 - Accepted
The request has been accepted for processing, but the processing has not been completed.
Show more