Transaction ID based and Instant refund

Response

Response Params

Value

Description

unique_request_id

String

The unique ID provided by the merchant to identify refund object.

reference_id

String

Reference number provided by the underlying gateway

order_id

String

Order ID for which the refund was initiated.

txn_id

String

Transaction ID against which the refund was initiated.

amount

double

Amount refunded (or to be refunded)

created

String

Date time (ISO representation) when a refund was created

refund_type

String

‘INSTANT’ or ‘STANDARD’

refund_source

String

Underlying gateway used to initiate the refund transaction, this will be populated in instant refund case

gateway

String

Underlying gateway used to initiate the refund transaction

epg_txn_id

String

Refund transaction id provided by the underlying gateway

status

String

Status 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_code

String

The Response code from the gateway when refund

error_message

String

The response message from the gateway when refund

refund_arn

String

The Reference number provided by Acquirers bank to track the refund at Issuers bank. May not be available for all the gateways

authorization_id

String

Authorization Identification Code issued by the Issuer bank for a successful refund transaction. May not be available for all the gateways

sent_to_gateway

String

This will be set to true once the refund is initiated to a gateway from Juspay

initiated_by

String

Username of the initiating user. This will be “API” in case of initiated via API

id

String

ID 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
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!