Refunds, Cancels, and Voids
Refunds, cancels, and voids handle different moments in the payment lifecycle. Use the operation that matches the current state of the payment session.
Cancel a pending session
Cancel a payment session when checkout should no longer continue and the customer has not entered payment details yet. After cancellation, keep the order unpaid or let the customer choose another payment method.
Void an authorization
Void a session when you used Manual/Delayed Capture and no longer want to capture the authorization. Voiding releases the hold instead of settling funds.
Refund a captured payment
Refund a payment after funds are captured. Use refunds for post-payment returns, order adjustments, or customer support cases where funds need to move back to the customer.
For itemized orders, use the payment session details and webhook payloads to reconcile which items or amounts remain refundable.
Choosing the right operation
If you are not sure which state a payment is in, retrieve the payment session first:
GET /payments/v1/payment_session/{business_id}.