Sign in
latestOpenAPI 3.0.12026-08-104242199.9 KB

8df83424e244

Transfer requests

Create transfer request

Creates a transfer request and associates it with the account specified in the request URL. This method will create a reservation on the account for the amount specified in the transfer request.

post/v1/accounts/{account_id}/transfer_requests

Path parameters

account_idstring required

Request body

referencestring

A unique reference for the transfer request. Acts as an idempotency key.

descriptionstring

A description for the transfer request.

Example request

{
  "amount": {
    "value": 10000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reference": "e8eabf80-095f-4d6a-947a-4ca1455cc378",
  "description": "An example description"
}

Response

Transfer request created successfully

idstring

Unique ID of the transfer request.

reservation_idstring

Unique ID of the reservation associated with the transfer request.

referencestring

A unique reference for the transfer request. Used as an idempotency key.

descriptionstring

The description of the transfer request.

resolvedboolean

Indicates whether the transfer request was resolved.

Example response

{
  "id": "d3441a66f78e6290cdeebc4c1689a4aetreq",
  "reservation_id": "88cedf447b2c43828ded233733d1cc54",
  "reference": "e8eabf80-095f-4d6a-947a-4ca1455cc378",
  "description": "Example description"
}