v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB

Transfers

Fetches a paginated list of your transfers

Retrieves a list of the transfers you've requested. Returned in sorted (by epoch) order (default is newest first)

get/transfers

Query parameters

ascendingboolean

Control the order (newest or oldest) in which the transfers are returned. false will arrange the results with newest first whereas true shows oldest first

limitinteger

Control how many transfers are returned in the result list. The max limit we allow is 50.

Example:20

startsAfterstring

Example:tfr_01FCTS1XMKH9FF43CAFA4CXT3P

A token to identify where to resume a subsequent paginated query. The value of the paginationToken field from that response should be supplied here in order to retrieve the next page of results.

Response

Successfully retrieved your transfers

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'startsAfter' query parameter. This field is null when there are no further items to return.

Example response

{
  "items": [
    {
      "id": "tfr_01FCTS1XMKH9FF43CAFA4CXT3P",
      "status": "Completed",
      "amount": 75000,
      "currency": "GBP",
      "reason": "Covering dispute fees of £25 from 25th October",
      "source": {
        "accountId": "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"
      },
      "destination": {
        "accountId": "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"
      },
      "errors": [
        {
          "code": "InsufficientSourceBalance",
          "description": "The account did not have sufficient funds available to cover this transfer"
        }
      ],
      "metadata": {
        "orderId": "1",
        "customerId": "123"
      },
      "createdTimestamp": 1470989538,
      "lastUpdatedTimestamp": 1470989538
    }
  ],
  "paginationToken": "tfr_01FCTS1XMKH9FF43CAFA4CXT3P"
}