JavaScript is disabled. Some features may not work. You can also read the static version: View text version

List payout methods

List all payout instrument options available for a specific order. This API provides information on the refund supported, last date to initiate the refunds, payment source details, applicable payout methods along with input validation fields required for processing payout through the Payout Refunds API.

Please do not cache the response of this API, as the refund back to source are time dependent.

It includes two important fields: back_to_source_supported and last_date_to_refund.
Based on the values of back_to_source_supported and last_date_to_refund, refunds via source or refund via payout can be decided.
- If back_to_source_supported is true and there is sufficient time remaining before the last_date_to_refund, Refund API(refunds via source) can be initiated.
- If back_to_source_supported is true but the last_date_to_refund has passed, Payout refund API(refunds via payout) should be used.
- If back_to_source_supported is false, only Payout refund API(refunds via payout) can be used.
If List payout methods response does not include two fieldsback_to_source_supported and last_date_to_refund,Refund API(refunds via source) can be initiated directly.

Request

Response

API Endpoints

Sandbox Link

GET

https://sandbox.juspay.in/refundMethods

Production Link

GET

https://api.juspay.in/refundMethods

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      
                      

string

Recommended

Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.

Passing this value will help us route efficiently at network level.

Example:- x-merchantid: testaccount

                      Content-Type
                      
                      

String

application/x-www-form-urlencoded

                      order_id
                      *
                      

String

Mandatory

An identifier for the order for which the refund has to be processed

                      preferred_gateways
                      
                      

URLEncoded(String)

Optional

Specify your preferred Payout gateway for the refund processing. This will filter out payout_methods specific to that gateway.

                      bank_country_code
                      
                      

String

Optional

Send customer bank account country code. Default country code will be derived from the destination currency of the order

Response Body

                      back_to_source_supported
                      
                      

Boolean

Indicates whether refunding back to the original source is supported

                      last_day_to_refund
                      
                      

String (ISO 8601 format)

Specifies the last possible date and time for a refund for back to source.

                      source_details
                      
                      

Object

Contains information about the original payment method.

                      payment_method_type
                      
                      

String

Indicates the type of payment method used for the original transaction.
Possible Values: CARD, BANK_TRANSFER, etc.

                      payment_method
                      
                      

String

Specifies the actual payment method used.
Possible Values: VISA/MASTERCARD/GRABPAY/APPLEPAY, etc.

                      last_four_digits_of_card
                      
                      

String

Displays the last four digits of the card used.
(Applicable only if payment_method_type is CARD)

                      card_isin
                      
                      

String

International Securities Identification Number (ISIN) of the card.
(Applicable only if payment_method_type is CARD)

                      payout_methods
                      
                      

Array

Possible payout methods

                      type
                      
                      

string

Type of payout available for the order_id shared in the request
Possible Values: BANK_TRANSFER

                      transfer_type
                      
                      

string

Payout transfer type
Possible Values: INTERNATIONAL, LOCAL

                      payout_mode
                      *
                      

String

Mandatory

Payout mode processed for order_id in the request
Possible Values: IBAN, FAST

                      supported_gateways
                      
                      

Array Of Objects

Array of supported gateways to process the payout refunds.

                      gateway
                      
                      

String

Gateway which are available for payout

                      supported_reference_ids
                      
                      

String

The Gateway Reference ID is associated with the respective configured payout gateway for payout processing

                      beneficiary_details
                      *
                      

String

Mandatory

Beneficiary details required to process the payout

key

String

It holds the field value

                      title
                      
                      

String

Title for key

                      description
                      
                      

String

Field which holds few words/ description on the title

                      regex
                      
                      

regex

Value format forkeyfield

                      required
                      
                      

Boolean

Field which denotes whetherkeyis mandatory to input from the user and pass the values to payout refund API

Response Body

                      status
                      
                      

string

error

                      error_code
                      
                      

string

access_denied

Have questions?
Need help? Contact support
LLM? Read llms.txt