API Reference

Refund Transaction

Refund transaction API is used to raise the refund transaction with PG. It supports partial as well as full refund. While doing create transaction, refund configurations need to be provided i.e. PARTIAL or FULL. In case of full refund, no duplicate refund transaction request will be allowed unless previously created refund transaction has failed. Generally, post settlement of the transaction, this API can be used to request for refund of partial amount or full amount. In case of AUTH-CAPTURE transaction, total amount that can be refunded should be equal to less than total captured amount.

Transaction Idempotency

If appUtr is present in the API request, then the refund transaction will be made idempotent. If another refund transaction is requested with the duplicate appUtr, then API will reject the refund transaction.

HTTP Status and Response Status Matrix

HTTP
Status
Response StatusResponse Message
200REFUNDEDSuccess
200ALREADY_REFUNDEDWe see a refund has already been processed.
200CREATED/PROCESSINGRefund transaction is created with processor and a response is awaited
200PROCESSINGRefund transaction is created with processor and is in processing state at gateway
400VALIDATION_ERRORIn case of VALIDATION_ERROR, field specific validation details will be returned.
400REJECTEDNo transaction found to refund. Please provide valid transactionUtr
400REJECTEDRefund transaction not allowed as original transaction still not processed or already refunded
400REJECTEDApp UTR provided is already used
400REJECTEDRefund transaction not allowed for invalid refund config
400REJECTEDRefund transaction window expired
400ERROR_FROM_PGThis will be populated by processor
404ERROR_FROM_PGThis will be populated by processor
404TRANSACTION_NOT_FOUNDThis will be populated by processor
500ERROR_FROM_PGThis will be populated by processor
500ERROR_FROM_PGError in gateway response
500INTERNAL_PROCESSING _ERRORSomething went wrong at our end, try again after some time
502ERROR_CONNECTING_PGGateway connectivity unavailable
503ERROR_CONNECTING_PGGateway connectivity unavailable
503SERVICE_UNAVAILABLEWe see a downtime at our end. Please try again sometime!
Language
Credentials
Bearer
Click Try It! to start a request and see the response here!