Overview of the refunds response object.
Shown below is a sample response returned through our Refund API.
{
"data": {
"order_id": "v1-241010071949-aa-vcqtJY",
"parent_order_id": "v1-241010055924-aa-AHbN0s",
"merchant_order_reference": "e436fefa-f0e9-4b36-ac01-3d158c31726c",
"type": "REFUND",
"status": "PROCESSED",
"merchant_id": "108272",
"order_amount": {
"value": 400,
"currency": "INR"
},
"purchase_details": {
"customer": {
"email_id": "[email protected]",
"first_name": "Kevin",
"last_name": "Bob",
"customer_id": "123456",
"mobile_number": "9876543210",
"billing_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London"
},
"shipping_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London"
}
},
"merchant_metadata": {
"key1": "XX",
"key2": "DOF"
}
},
"payments": [
{
"id": "v1-241010071949-aa-vcqtJY-cc-b",
"status": "PROCESSED",
"payment_amount": {
"value": 400,
"currency": "INR"
},
"payment_method": "CARD",
"acquirer_data": {
"approval_code": "",
"acquirer_reference": "7285447904236780703954",
"rrn": "",
"is_aggregator": true
},
"created_at": "2024-10-10T07:19:49.423Z",
"updated_at": "2024-10-10T07:19:51.205Z"
}
],
"created_at": "2024-10-10T07:19:49.424Z",
"updated_at": "2024-10-10T07:19:51.205Z"
}
}
{
"data": {
"order_id": "v1-250226115026-aa-JO3YTv",
"parent_order_id": "v1-250226114507-aa-tDpkuP",
"merchant_order_reference": "merchant-reference-r4y",
"type": "REFUND",
"status": "PROCESSED",
"merchant_id": "122743",
"order_amount": {
"value": 21000,
"currency": "INR"
},
"purchase_details": {
"customer": {
"country_code": "91",
"billing_address": {},
"shipping_address": {},
"is_edit_customer_details_allowed": false
},
"merchant_metadata": {
"key1": "value1",
"key2": "value2"
},
"split_info": {
"split_type": "AMOUNT",
"split_details": [
{
"parent_order_split_settlement_id": "v1-250513063000-aa-UBAnaE-ss-g",
"split_merchant_id": 117230,
"split_settlement_id": "v1-5312042524-aa-0YO29z-ss-a",
"merchant_settlement_reference": "ref1",
"amount": {
"value": 21000,
"currency": "INR"
},
"status": "DO_NOT_RECOVER"
}
]
}
},
"payments": [
{
"id": "v1-250226115026-aa-JO3YTv-cc-a",
"status": "PROCESSED",
"payment_amount": {
"value": 21000,
"currency": "INR"
},
"payment_method": "CARD",
"acquirer_data": {
"approval_code": "",
"acquirer_reference": "7405706270796283203814",
"rrn": "",
"is_aggregator": true,
"acquirer_name": "Cyber_Source_AXIS"
},
"offer_data": {},
"created_at": "2025-02-26T11:50:26.351Z",
"updated_at": "2025-02-26T11:50:27.718Z"
}
],
"created_at": "2025-02-26T11:50:26.352Z",
"updated_at": "2025-02-26T11:50:27.718Z",
"integration_mode": "SEAMLESS",
"payment_retries_remaining": 10
}
}
{
"data": {
"order_id": "v1-250513063438-aa-83Pcx8",
"parent_order_id": "v1-250513063000-aa-UBAnaE",
"merchant_order_reference": "0a049dd9-74eb-4a84-9d77-f639d9d889bc",
"type": "REFUND",
"status": "PROCESSED",
"merchant_id": "111370",
"order_amount": {
"value": 8800,
"currency": "INR"
},
"purchase_details": {
"customer": {
"country_code": "91",
"billing_address": {},
"shipping_address": {},
"is_edit_customer_details_allowed": false
},
"merchant_metadata": {
"key1": "value1",
"key2": "value2"
},
"split_info": {
"split_type": "AMOUNT",
"split_details": [
{
"parent_order_split_settlement_id": "v1-250513063000-aa-UBAnaE-ss-g",
"split_merchant_id": "111370",
"split_settlement_id": "v1-250513063438-aa-83Pcx8-ss-c",
"amount": {
"value": 800,
"currency": "INR"
},
"status": "DO_NOT_RECOVER",
"updated_at": "2025-05-13T06:34:38.036Z"
},
{
"parent_order_split_settlement_id": "v1-250513063000-aa-UBAnaE-ss-h",
"split_merchant_id": "111370",
"split_settlement_id": "v1-250513063438-aa-83Pcx8-ss-d",
"amount": {
"value": 8000,
"currency": "INR"
},
"status": "DO_NOT_RECOVER",
"updated_at": "2025-05-13T06:34:38.036Z"
}
]
}
},
"payments": [
{
"id": "v1-250513063438-aa-83Pcx8-cc-a",
"status": "PROCESSED",
"payment_amount": {
"value": 8800,
"currency": "INR"
},
"payment_method": "CARD",
"acquirer_data": {
"approval_code": "",
"acquirer_reference": "7471180795846584503814",
"rrn": "",
"is_aggregator": true
},
"offer_data": {},
"created_at": "2025-05-13T06:34:38.036Z",
"updated_at": "2025-05-13T06:34:40.256Z"
}
],
"created_at": "2025-05-13T06:34:38.036Z",
"updated_at": "2025-05-13T06:34:40.256Z",
"integration_mode": "SEAMLESS",
"payment_retries_remaining": 10
}
}
The table below lists the various parameters returned in the orders response objects.
Parameter | Type | Description |
---|---|---|
order_id | string | Unique identifier of the order in the Plural database.
v1-5757575757-aa-hU1rUd |
parent_order_id | string | Unique identifier of the parent order in the Plural database.
v1-5757575757-aa-hU1rUd |
merchant_order_reference | string | Unique identifier entered while creating a refund.
82d57572-057c-4826-5775-385a52150554 |
type | string | Payment type. Possible values:
|
status | string | Order status. Possible values:
|
merchant_id | string | Unique identifier of the merchant in the Plural database. Example: 123456 |
order_amount | object | An object that contains the transaction amount details. Learn more about the order_amount child object. |
purchase_details | object | An object that contains the purchase details. Learn more about the purchase_details child object.Note: The presence of the object key-values depends on the Input request. |
payments | array of objects | An array of objects that contains the payment details. Learn more about the payments child object.Note: Payment object is returned only for the orders linked with a payment. |
created_at | string | The ISO 8601 UTC Timestamp, when the create refund request was received by Plural. Example: 2024-07-09T07:57:08.022Z |
updated_at | string | The ISO 8601 UTC Timestamp, when the refund object is updated. Example: 2024-07-09T07:57:08.022Z |
Order Amount [Child Object]
The table below lists the various parameters in the order_amount
child object. This object is part of the orders sample response object.
Parameter | Type | Description |
---|---|---|
value | integer | Transaction amount is Paisa.
1000 |
currency | string | Type of currency. Example: INR |
Purchase Details [Child Object]
The table below lists the various parameters in the purchase_details
child object. This object is part of the orders sample response object.
Parameter | Type | Description |
---|---|---|
customer | Object | An object that contains the customer details. Learn more about the customer child object. |
merchant_metadata | object | An object of key-value pair that can be used to store additional information. Example: "key1": "DD" |
split_info | object | An object that contains the split information details. Learn more about the split_info child object. |
Customer [Child Object]
The table below lists the various parameters in the customer
child object. This is part of the purchase_details
object.
Parameter | Type | Description |
---|---|---|
email_id | string | Customer's email address.
[email protected] |
first_name | string | Customer's first name.
Kevin |
last_name | string | Customer's last name.
Bob |
customer_id | string | Unique identifier of the customer in the Plural database.
123456 |
mobile_number | string | Customer's mobile number.
9876543210 Supported characters:
|
billing_address | object | An object that contains the details of the billing address. Learn more about the billing_address child object. |
shipping_address | object | An object that contains the shipping address details. Learn more about the shipping_address child object. |
Billing Address [Child Object]
The table below lists the various parameters in the billing_address
child object. This is part of the customer
object.
Parameter | Type | Description |
---|---|---|
address1 | string | Customer's billing address1.
10 Downing Street Westminster London |
address2 | string | Customer's billing address2.
Oxford Street Westminster London |
address3 | string | Customer's billing address3.
Baker Street Westminster London |
pincode | string | Pincode of the billing address.
51524036 Supported characters:
|
city | string | City of the billing address.
Westminster |
state | string | State of the billing address.
Westminster |
country | string | Country of the billing address.
London |
Shipping Address [Child Object]
The table below lists the various parameters in the shipping_address
child object. This is part of the customer
object.
Parameter | Type | Description |
---|---|---|
address1 | string | Customer's shipping address1.
10 Downing Street Westminster London |
address2 | string | Customer's shipping address2.
Oxford Street Westminster London |
address3 | string | Customer's shipping address3.
Baker Street Westminster London |
pincode | string | Pincode of the shipping address.
51524036 Supported characters:
|
city | string | City of the shipping address.
Westminster |
state | string | State of the shipping address.
Westminster |
country | string | Country of the shipping address.
London |
Split Info [Child Object]
The table below lists the various parameters in the split_info
child object. This is part of the purchase_details
object.
Parameter | Type | Description |
---|---|---|
split_type | string | Type of split. Example: Amount |
split_details | array of objects | An array of objects that contains the split details. Learn more about the split_details child object. |
Split Details [Child Object]
The table below lists the various parameters in the split_details
child object. This is part of the split_info
object.
Parameter | Type | Description |
---|---|---|
parent_order_split_settlement_id | string | Unique identifier of the split settlement in the Plural database. Example: v1-5757575757-aa-hU1rUd |
split_merchant_id | string | Unique identifier of your partner merchant in the Plural database. Example: 123456 |
amount | object | An object that contains the split amount details. Learn more about the amount child object. |
status | string | Split Settlement recovery status. Possible values:
|
Payments [Child Object]
The table below lists the various parameters in the payments
child object. This object is part of the payments sample response object.
Parameter | Type | Description |
---|---|---|
id | string | Unique identifier of the payment in the Plural database.
v1-5206071124-aa-mpLhF3-cc-l |
status | string | Payment status. Possible values:
PENDING |
payment_amount | object | An object that contains the details of the payment amount. Learn more about our payment_amount child object. |
payment_method | string | Type of payment method. Accepted values:
CARD |
acquirer_data | object | An object that contains the details of the acquirer data. Learn more about our acquirer_data child object. |
created_at | string | The ISO 8601 UTC Timestamp, when the create payment request was received by Plural. Example: 2024-07-09T07:57:08.022Z |
updated_at | string | The ISO 8601 UTC Timestamp, when the payment object is updated. Example: 2024-07-09T07:57:08.022Z |
Payment Amount [Child Object]
The table below lists the various parameters in the payment_amount
child object. This object is part of the payments
object.
Parameter | Type | Description |
---|---|---|
value | integer | The transaction amount is Paisa.
100 |
currency | string | Type of currency. Example: INR |
Acquirer Data [Child Object]
The table below lists the various parameters in the acquirer_data
child object. This object is part of the payments
object.
Parameter | Type | Description |
---|---|---|
approval_code | string | Authorization code returned from acquirer against the payment.
030376 |
acquirer_reference | string | Unique reference returned from acquirer for the payment.
202455840588334 |
rrn | string | Retrieval reference number returned from acquirer for the payment.
419335023601 |
is_aggregator | boolean | The selected aggregator model type. Accepted values:
|