POST /transfers/{transferId}/returns
Initiates the return of previously transferred funds without creating a new transferId.
Servers
- https://balanceplatform-api-test.adyen.com/btl/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
transferId |
String | Yes |
The unique identifier of the transfer to be returned. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Idempotency-Key |
String | No |
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
amount |
Object | Yes |
Contains information about the amount to be returned. |
amount.value |
Integer | Yes |
The amount of the transaction, in minor units. |
amount.currency |
String | Yes |
The three-character ISO currency code. |
reference |
String | No |
Your internal reference for the return. If you don't provide this in the request, Adyen generates a unique reference. This reference is used in all communication with you about the instruction status. We recommend using a unique value per instruction. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). |
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.