v1

latestOpenAPI 3.0.02026-07-1491520.4 KB
Transfers

Retrieve list of credit transfers

Retrieve a list of credit transfers that have taken place for a primary account within a specified time period.

get/{api_key}/credit-transfers

Path parameters

api_keystring required

ID of the primary account.

Query parameters

start_datestring required

Start of the retrieval period.

end_datestring

End of the retrieval period. If absent then all transfers until now is returned.

subaccountstring

Subaccount to filter by. You may send this multiple times to filter on multiple subaccounts

Response

List credit transfers response

Example response

{
  "_embedded": {
    "credit-transfers": [
      {
        "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"
      }
    ]
  }
}