/v2/transfers/{id}

GET

Get a money transfer record.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required
NameInTypeDescription
X-Auth-Token header string Authentication token.
id path string Transfer UUID.
Optional
NameInTypeDescription
on_behalf_of query string Contact UUID.
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/transfers/{id}

Response

{
    "id": "c30f99b1-f523-476b-97d0-e5e9a344c244",
    "short_reference": "BT-20201023-KJCNRV",
    "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
    "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
    "currency": "GBP",
    "amount": "100.00",
    "status": "pending",
    "reason": "",
    "created_at": "2020-10-23T08:32:15+00:00",
    "updated_at": "2020-10-23T08:32:15+00:00",
    "completed_at": "",
    "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
}
Error Codes
HTTP Status Code Description Params
400 id_is_not_valid_uuid id should be in UUID format
on_behalf_of_self You cannot act on behalf of your own Contact
transfer_not_found Transfer was not found for this ID
contact_not_found Contact was not found for this id
401 invalid_supplied_credentials Authentication failed with the supplied credentials
429 too_many_requests Too many requests have been made to the api. Please refer to the Developer Center for more information
500 internal_server_error Internal server error
503 service_unavailable Service is temporary unavailable
Was this post helpful?
Let us know if you liked the post. That’s the only way we can improve.
Yes
No