Void a Payment

This endpoint is only relevant to Forage SDK integrations.

If you’re building with the Fully Hosted or Custom Forage Checkout UI, then use the Order and OrderPayment endpoints.

⚠️

In most cases, instead of voiding a Payment, create a PaymentRefund.

PaymentRefunds and voided Payments have the same impact on settlement, but refunds provide a better paper trail. The refunds API also gives you more granular control over, for example, the fraction of the original Payment to refund.

A POST request to /payments/{payment_ref}/void/ submits a reversal message to Forage that voids the payment transaction.

On success, this endpoint reverses the impacts of the payment on daily net settlement. The API responds with the original Payment object.

🚧

The balance value in the response does not reflect the voided transaction.

The returned balance amount accounts for the original transaction, before the void. A customer must check their balance via PIN entry to get the post-void balance.

Language
Authorization
OAuth2
URL