Transfer requests

Index transfer requests for an account

Returns an array containing all transfer requests associated with the account specified in the request URL.

get/v1/accounts/{account_id}/transfer_requests

Path parameters

account_idstring required

Query parameters

filter[resolved]boolean

Use this filter to return only resolved transfers.

filter[reference]string

Filter the response by the reference property.

filter[reservation_id]string

Filter the response by the reservation ID associated with the transfer request.

Response

The operation was successful.

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"
  }
]