v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB

Transfers

Retrieve a transfer by Id

This is used to fetch a transfer by its unique Id

get/transfers/{id}

Path parameters

idstring required

Example:tfr_01FCTS1XMKH9FF43CAFA4CXT3P

Transfer to retrieve

Response

Successfully retrieved the given Transfer

idstring

The unique id of the transfer

status'Pending' | 'Declined' | 'Completed'

The status the transfer is currently in

amountinteger

The transfer amount (in minor units)

currencystring

The ISO currency code

reasonstring nullable

An optional reason describing why the transfer was initiated.

metadataobject nullable

Your custom key-value data for the transfer. You can have a maximum of 5 pieces of metadata.

createdTimestampinteger

The epoch timestamp (seconds) when the transfer was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the transfer was last updated

Example response

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