Pay out from an account to the account holder

post/payoutAccountHolder

API Version

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

Endpoint destination URL

https://cal-test.adyen.com/cal/services/Fund/v6/payoutAccountHolder

Request Parameters

Required

Optional

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.

Max length: 200

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

200 - OK
The request has succeeded.
bankAccountUUIDstring
The unique ID of the Bank Account to which the payout was made.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
merchantReferencestring
The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.
payoutSpeedstring
Speed with which payouts for this account are processed. Permitted values: STANDARD, SAME_DAY.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
202 - Accepted
The request has been accepted for processing, but the processing has not been completed.
bankAccountUUIDstring
The unique ID of the Bank Account to which the payout was made.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
merchantReferencestring
The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.
payoutSpeedstring
Speed with which payouts for this account are processed. Permitted values: STANDARD, SAME_DAY.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
400 - Bad Request
A problem reading or understanding the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Pay out from an account to the account holder

HTTP Responses

200 - OK

202 - Accepted

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error