/v2/conversions/{id}/cancel

POST

Cancels the conversion identified by the provided unique id {id}

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 ID of the conversion that is being cancelled
Optional
NameInTypeDescription
notes formData string Notes describing the reason for cancellation.
curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/conversions/{id}/cancel

Response

{
    "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "event_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "event_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "conversion_id": "d391e0a1-2643-44ff-b063-bbe39c98a2b5",
    "event_type": "self_service_cancellation",
    "amount": "-0.01",
    "currency": "GBP",
    "notes": "",
    "event_date_time": "2018-11-15T14:08:08+00:00"
}
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
contact_not_found Contact was not found for this id
invalid_extra_parameters Invalid extra parameters extra_parameter { "parameters" => "extra_parameter" }
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
No