Body
Create Refund for Split Settled Transactions
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/orders/{order_id}/refunds
Production Link
POST
https://api.juspay.in/orders/{order_id}/refunds
Headers
Content-Type
*
string
Required
application/x-www-form-urlencoded
Authorization
*
string
Required
Basic of Base64 encoded API Key
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Path Params
order_id
*
String
Mandatory
Order Id
Example:- ord_3876784
Parameters
amount
*
string
Required
Amount that has to be refunded. Amount has to be less than or equal to the amount of the order that is not yet refunded.
unique_request_id
*
string
Required
Request ID that uniquely identifies this request. You cannot reuse the value for two different refund requests. This is to avoid processing duplicate refund requests.
metadata
*
object
Required
This field describes how much amount has to be refunded from the respective sub account ids.
split_settlement_details
string
RequiredTag
This field describes how much amount has to be refunded from the respective sub account ids.
marketplace
JSON
Conditional
Marketplace (Parent merchant account ID) refund specific data to be passed
refund_amount
*
Number
Mandatory
Refund amount to be reversed from the parent merchant settlement account
NOTE: Refund Amount is to be passed with Decimal values and has to be less than or equal the split amount passed in the Order
vendor
JSON
Conditional
Vendor (Sub account IDs) specific data to be passed
split
Array
Conditional
Split settlement refund information to be passed
sub_mid
*
String
Mandatory
Sub Account ID (maintained at JusPay’s end) to be passed.
refund_amount
*
Number
Mandatory
Refund Amount to be reversed from the sub account
NOTE: Refund Amount is to be passed with Decimal values and has to be less than or equal the split amount passed in the Order
200 : Success
Response Body
udf1-10
string
txn_uuid
string
eul4bnuBAnnC7UivV8k
txn_id
string
splitsettlement_1619009418_test
status_id
integer
status
string
CHARGED
split_settlement_response
object
split_details. sub_vendor_id
String
split_details.amount
Integer
split_applied
Boolean
return_url
string
https://www.google.com
refunds
array
refunded
boolean
product_id
string
payment_method_type
string
CARD
payment_method
string
VISA
payment_links
object
web
string
https://api.juspay.in/merchant/pay/ordeh_16c54f506c1143a88d2aca61533e8b56
mobile
string
https://api.juspay.in/merchant/pay/ordeh_16c54f506c1143a88d2aca61533e8b56?mobile=true
iframe
string
https://api.juspay.in/merchant/ipay/ordeh_16c54f506c1143a88d2aca61533e8b56
payment_gateway_response
object
txn_id
string
splitsettlement_1619009418_test
rrn
string
768370
resp_message
string
Approved
resp_code
string
Success
epg_txn_id
string
110086948408
created
string
2021-04-21T06:28:49Z
auth_id_code
string
NA
order_id
string
splitsettlement_1619009418_test
merchant_id
string
merchant identifier
id
string
ordeh_16c54f506c1143a88d2aca61533e8b56
gateway_reference_id
null
gateway_id
integer
date_created
string
2021-04-21T06:28:09Z
customer_phone
string
9987039379
customer_id
string
cst_1845074
customer_email
string
juspay@juspay.in
currency
string
INR
card
object
using_saved_card
boolean
saved_to_locker
boolean
name_on_card
string
XXXX
last_four_digits
string
expiry_year
string
expiry_month
string
card_type
string
DEBIT
card_reference
string
card_issuer
string
IDFC Bank
card_isin
string
card_fingerprint
string
card_brand
string
VISA
bank_error_message
string
bank_error_code
string
auth_type
string
THREE_DS
amount_refunded
integer
amount
integer
400 : Invalid Input data
Response Body
status_id
integer
status
string
ERROR
error_message
string
Refund amount exceeds the refundable amount.
error_code
string
invalid.amount.exceeded
Have questions?
- Need help? Contact support
- LLM? Read llms.txt