Refunds

Refunds enable you to refund your end users. You can issue refunds for any Payment Initiation payments that have settled in your virtual account.

• Only refunds for the full payment amount are supported.

  • The full original payment amount will be refunded to the source account the payment was initiated from. The refund will be initiated from the virtual account that the payment settled in.

  • To power partial refunds, use the Payouts API, where you can specify the exact amount for a payout to an end user.

• Only 1 successful refund is allowed per payment.

• Only payments that are in the SETTLED status can be refunded.

Make sure your virtual account is set up before following these steps.

1. Follow the Payment Confirmation flow to pay into your virtual account.

2. Call /wallet/get to check your virtual account balance for sufficient funds.

   • If you have insufficient funds, fund your virtual account before proceeding. After funding your virtual account, you can check the updated balance by calling /wallet/get.

3. Issue a refund by calling /payment_initiation/payment/reverse and providing the payment_id from the payment made in Step 3. Store the refund_id and status from the response.

   • If you have configured transaction webhooks, you will receive a status update that the Refund transitioned from INITIATED to EXECUTED.

   • Alternatively, if not using webhooks, you can confirm the transaction has been executed by calling /wallet/transaction/get with the transaction_id.

   • You can also confirm that the original payment was refunded by calling /payment_initiation/payment/get with the payment_id to see the refund_id as part of the payment’s details.

A successful refund will transition to the EXECUTED status. If a refund is in a FAILED status, you may try again, with a new idempotency_key, until you have a refund in an EXECUTED status for the payment. Refunds should transition to EXECUTED or FAILED automatically. If this does not occur,