POST /payoutAccountHolder
Pays out a specified amount from an account to the bank account of account holder.
Servers
- https://cal-test.adyen.com/cal/services/Fund/v6
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
A description of the payout. Maximum 200 characters. Allowed: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ "; |
payoutMethodCode |
String | No |
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. |
merchantReference |
String | No |
A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another. |
accountCode |
String | Yes |
The code of the account from which the payout is to be made. |
amount |
Object | No |
An object containing the currency and value of the payout.
If the account has multiple currencies, specify the currency to be used.
If the |
amount.value |
Integer | Yes |
The amount of the transaction, in minor units. |
amount.currency |
String | Yes |
The three-character ISO currency code. |
payoutSpeed |
String | No |
Speed with which payouts for this account are processed. Permitted values: Possible values:
Default value: "STANDARD" |
bankAccountUUID |
String | No |
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. |
accountHolderCode |
String | Yes |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.