CHcheckout
Payments

Cancel a scheduled retry

Cancels an upcoming retry, if there is one scheduled

Cancellation requests are processed asynchronously. You can use workflows to be notified if the cancellation is successful.

post/payments/{id}/cancellations

Request

Path parameters

idstring required

The unique payment identifier.

Headers

Cko-Idempotency-Keystring

An optional idempotency key for safely retrying payment requests

Request body

referencestring

A reference you can later use to identify this cancellation request. You can use this value to identify the cancellation request later.

Example request

{
  "reference": "ORD-5023-4E89"
}

Response

Cancellation accepted

action_idstring required

The action identifier

referencestring

Your reference for the cancellation request.

Example response

{
  "action_id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
  "reference": "ORD-5023-4E89"
}

Changes

No recorded changes to this operation across all 1 revision of this API.