Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Transfers

Initiates a transfer of money between Ryft accounts

Used to initiate a transfer of money between Ryft accounts.

post/transfers

Request body

amountinteger required

The amount (in minor units) to transfer. Minimum 1 minor unit.

currencystring required

The three-letter ISO currency code

reasonstring nullable

An optional reason describing why the transfer was initiated. Not required but recommended.

metadataobject nullable

Used to attach any custom key-value data to the transfer. You can have a maximum of 5 pieces of metadata.

Example request

{
  "amount": 5000,
  "currency": "GBP",
  "source": {
    "accountId": "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"
  },
  "destination": {
    "accountId": "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"
  },
  "reason": "Covering dispute fees of £25 from October 10th",
  "metadata": {
    "orderId": "1",
    "customerId": "123"
  }
}

Response

Successfully initiated the 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
}