CHcheckout
Payments

Void a payment

Voids a payment if supported by the payment method.

For card payments, void requests are processed asynchronously. You can use workflows to be notified if the void is successful.

post/payments/{id}/voids

Request

Path parameters

idstring required

The payment identifier

Headers

Cko-Idempotency-Keystring

An optional idempotency key for safely retrying payment requests

Request body

amountinteger

The amount to void. If not specified, the full payment amount will be voided.

referencestring

A reference you can later use to identify this void request.<br>For Amex, the string limit is 30 characters.

metadataobject

A set of key-value pairs to attach to the authorization request. You can use this to store additional information in a structured format.

The metadata object only supports primitive data types. Objects and arrays are not supported.

Example request

{
  "amount": 6540,
  "reference": "ORD-5023-4E89",
  "metadata": {
    "coupon_code": "NY2018",
    "partner_id": 123989
  }
}

Response

Payment is already voided

action_idstring required

The action identifier

Example response

{
  "action_id": "act_y3oqhf46pyzuxjbcn2giaqnb44"
}

Changes

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