Request a transfer to be cancelled.

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

X-Auth-Token header string Authentication token.
id path string ID of the transfer that is to be cancelled
curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/transfers/{id}/cancel


    "id": "6c19f186-4c4d-4854-ad09-fdeee792ed25",
    "short_reference": "BT-20220117-HNJGHM",
    "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": "2022-01-17T14:07:31+00:00",
    "updated_at": "2022-01-17T14:07:31+00:00",
    "completed_at": "",
    "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "unique_request_id": ""
Error Codes
HTTP Status Code Description Params
400 id_is_not_valid_uuid id should be in UUID format
transfer_not_found Transfer was not found for this ID
transfer_is_already_cancelled Transfer is already cancelled
transfer_is_already_completed Transfer has already completed (settled)
invalid_status Transfer is already cancelled
invalid_status Transfer cannot be cancelled since it is already completed
invalid_extra_parameters Invalid extra parameters extra_parameter { "parameters" => "extra_parameter" }
401 invalid_supplied_credentials Authentication failed with the supplied credentials
403 permission_denied You do not have permission 'transfer_write' to perform this operation
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.