Create Transfer - Currencycloud API Documentation

Home > Pay > Transfers > Create Transfer

/v2/transfers/create

POST

Transfer funds from one account to another account. No currency conversion is performed, so the sending and receiving accounts must hold money in the same currency.

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

Name	In	Type	Description
X-Auth-Token	header	string	Authentication token.
source_account_id	formData	string	Account UUID of the paying account.
destination_account_id	formData	string	Account UUID of the receiving account.
currency	formData	string	Three-digit currency code.
amount	formData	string	Amount.
Optional
Name	In	Type	Description
reason	formData	string	User-generated reason for transfer. Freeform text.

curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/transfers/create

Response

{
    "id": "e129bb7e-069b-4ae7-bd9c-fc9102c320d0",
    "short_reference": "BT-20181017-BBFGCB",
    "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
    "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
    "currency": "GBP",
    "amount": "100.00",
    "status": "pending",
    "reason": null,
    "created_at": "2018-10-17T11:00:44+00:00",
    "updated_at": "2018-10-17T11:00:44+00:00",
    "completed_at": null,
    "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
}

Error Codes

HTTP Status	Code	Description
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 page helpful?

Yes

/v2/transfers/create

POST

API parameters

Required

Optional

Response

Error Codes

Start your borderless payments journey today

Cookies