/v2/payments/{id}/delete

POST

Delete a payment. On success, returns the final payment record state.

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 Payment UUID.
Optional
NameInTypeDescription
purpose_code formData string Payment Purpose Code (Mandatory for all INR payments).
on_behalf_of formData string Contact UUID.
curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/payments/{id}/delete

Response

{
    "id": "2fbfd98a-c25d-4141-a51e-ee2fc286ace5",
    "amount": "10.00",
    "beneficiary_id": "073a46aa-f9bf-4f17-ac1a-67b3ea874f22",
    "currency": "GBP",
    "reference": "This is a updated test reference.",
    "reason": "This is a updated test payment.",
    "status": "ready_to_send",
    "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "payment_type": "regular",
    "payment_date": "2018-11-15",
    "transferred_at": "",
    "authorisation_steps_required": "0",
    "last_updater_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "short_reference": "181115-GRGLLC001",
    "conversion_id": null,
    "failure_reason": "",
    "payer_id": "68561f01-b5d8-4fad-9bcb-d1712a1bc0c8",
    "payer_details_source": null,
    "created_at": "2018-11-15T14:08:12+00:00",
    "updated_at": "2018-11-15T14:08:14+00:00",
    "payment_group_id": null,
    "unique_request_id": null,
    "failure_returned_amount": "0.00",
    "ultimate_beneficiary_name": null,
    "purpose_code": null
}
Error Codes
HTTP Status Code Description Params
400 invalid_id ID has invalid format
on_behalf_of_self You cannot act on behalf of your own Contact
payment_not_found Payment 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 page helpful?
Yes
No