POST /cashouts
Initiates a cashout request.
Servers
- https://balanceplatform-api-test.adyen.com/btl/v4
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 |
|---|---|---|---|
id |
String | No |
The ID of the resource. |
description |
String | No |
Allowed and returned only when you provide the Your description of the cashout transfer. This description is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. If you do not provide a description, Adyen generates a description automatically. This generated description is not returned in the response. Supported characters: [a-z] [A-Z] [0-9] / - ? : ( ) . , ' + Space. |
transferInstrumentId |
String | No |
Use The unique identifier of the counterparty transfer instrument. |
amount |
Object | Yes |
Contains the amount of the cashout, in minor units. |
amount.value |
Integer | Yes |
The numeric value of the amount, in minor units. |
amount.currency |
String | Yes |
The three-character ISO currency code of the amount. |
referenceForBeneficiary |
String | No |
Allowed and returned only when you provide the The reference that is sent to the recipient of a cashout transfer. This reference is also sent in all webhooks related to the cashout transfer, so you can use it to track the status of the transfer. If you do not provide a reference for the beneficiary, Adyen generates one automatically. This generated reference for the beneficiary is not returned in the response. Supported characters: a-z, A-Z, 0-9. |
fee |
Object | No |
Contains the currency and value of the cashout fee, in minor units. |
fee.amount |
Object | Yes |
Contains the fee amount. |
fee.amount.value |
Integer | Yes |
The numeric value of the amount, in minor units. |
fee.amount.currency |
String | Yes |
The three-character ISO currency code of the amount. |
instructingBalanceAccountId |
String | Yes |
The unique identifier of the balance account that initiates the cashout request. |
counterparty |
Object | No |
Contains information about the counterparty of the cashout transfer. |
counterparty.transferInstrumentId |
String | No |
The unique identifier of the counterparty transfer instrument. If you do not provide this field, the cashout funds remain in the instructing balance account after the cashout transfer is settled. |
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.