Sign in

v1

latestOpenAPI 3.0.02026-07-1491520.4 KB
Transfers

Transfer credit

Transfer credit limit between a primary account and one of its subaccounts.

post/{api_key}/credit-transfers

Path parameters

api_keystring required

ID of the primary account

Request body

amountnumber required
fromstring required
referencestring
tostring required

Example request

{
  "from": "7c9738e6",
  "reference": "This gets added to the audit log",
  "to": "ad6dc56f"
}

Response

Credit transfer response

amountnumber

Credit transfer amount

created_atstring

The date and time when the credit transfer was executed

credit_transfer_idstring

Unique credit transfer ID

fromstring

Account the credit is transferred from

referencestring

Reference for the credit transfer

tostring

Account the credit is transferred to

Example response

{
  "amount": 123.45,
  "created_at": "2019-03-02T16:34:49Z",
  "credit_transfer_id": "07b5-46e1-a527-85530e625800",
  "from": "7c9738e6",
  "reference": "This gets added to the audit log",
  "to": "ad6dc56f"
}