Void a payment by supplying the order and payment object refs.

Please use the refunds endpoint (POST /api/orders/<order_ref>/refunds/) instead of this endpoint for most scenarios. Refunds and voided Payments have the same impact on settlement, but there is a much better paper trail for Refunds. Furthermore, the refunds API gives you more granular control over, for example, the fraction of the original Payment to refund.

Submits reversal message(s) to EBT processor which have the effect of voiding the payment transaction.

Calling this endpoint will reverse the impacts of the payment on daily net settlement.

Click Try It! to start a request and see the response here!