CHcheckout
Payments

Reverse a payment

Returns funds back to the customer by automatically performing the appropriate payment action depending on the payment's status.

For more information, see <a href="https://www.checkout.com/docs/payments/manage-payments/reverse-a-payment">Reverse a payment</a>.

post/payments/{id}/reversals

Request

Path parameters

idstring required

The unique identifier for the payment.

Headers

Cko-Idempotency-Keystring

An optional idempotency key for safely retrying payment requests

Request body

referencestring

An internal reference to identify the payment reversal.

For American Express payment reversals, there is a 30-character limit.

metadataobject

Stores additional information about the transaction with custom fields.

You can only supply primitive data types with one level of depth. Fields of type object or array are not supported.

Example request

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

Response

Payment is already reversed

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.