Transaction ID based and Instant refund

Response

Response ParamsValueDescription
unique_request_idStringThe unique ID provided by the merchant to identify refund object.
reference_idStringReference number provided by the underlying gateway
order_idStringOrder ID for which the refund was initiated.
txn_idStringTransaction ID against which the refund was initiated.
amountdoubleAmount refunded (or to be refunded)
createdStringDate time (ISO representation) when a refund was created
refund_typeString‘INSTANT’ or ‘STANDARD’
refund_sourceStringUnderlying gateway used to initiate the refund transaction, this will be populated in instant refund case
gatewayStringUnderlying gateway used to initiate the refund transaction
epg_txn_idStringRefund transaction id provided by the underlying gateway
statusStringStatus of the refund. Can be one of PENDING, SUCCESS, FAILURE, MANUAL_REVIEW.
SUCCESS: This means that the refund has been successfully executed.
PENDING: This would mean that the refund has been queued with JusPay or with the downstream system.
FAILURE: We were unable to process the refund successfully. You have to try again with new unique_request_id.
MANUAL_REVIEW: This would mean that the refund request was sent an ambiguous response from the payment gateway and the merchant has to manually reconcile it with the payment gateway to get the proper response.
response_codeStringThe Response code from the gateway when refund
error_messageStringThe response message from the gateway when refund
refund_arnStringThe Reference number provided by Acquirers bank to track the refund at Issuers bank. May not be available for all the gateways
authorization_idStringAuthorization Identification Code issued by the Issuer bank for a successful refund transaction. May not be available for all the gateways
sent_to_gatewayStringThis will be set to true once the refund is initiated to a gateway from Juspay
initiated_byStringUsername of the initiating user. This will be “API” in case of initiated via API
idStringID generated for the refund

📘

Note:

Instant Refund:

  • This API supports refunds for only JUSPAY orders, which are paid through cards and card details stored.
  • The API retrieves card details from the card vault from the order_id/txn_id passed in the refund request and attempt a payout on that card.
  • NON_JUSPAY orders and payment methods as NB and UPI refunds are not supported through this API, currently.
  • To enable Instant refunds, you will need to configure the MORPHEUS gateway from the Juspay dashboard. Please get in touch with [email protected] to get the credentials.
  • Please set Instant refund to TRUE from the Settings section of the Juspay dashboard.
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!