CLclinicos
Payments

Reverse a payment - tries void first (for unsettled transactions), falls back to refund. This is the recommended endpoint for canceling payments as it automatically picks the right method.

Changed on
post/Payments/{id}/reverse

Request

Path parameters

idstring required

The payment ID to reverse

Request body

reasonstring
destinationstring nullable

Where the money goes: "original" (default) voids/refunds the original tender; "storeCredit" grants the value to the client's credit ledger instead — no gateway call (ITE-655).

Response

OK

methodstring

The method used to reverse the payment: "Voided" or "Refunded"

messagestring

Human-readable message explaining the reversal

Changes

  • d4ae30be0619Revision changes
    • breaking

      the response property / became nullable for the status (media type: text/plain)

    • breaking

      the response property / became nullable for the status (media type: application/json)

    • breaking

      the response property / became nullable for the status (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

  • 503cd0546309Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)