Overview of the split settlement object.
Shown below is a sample response of a Release Settlement Fee API.
{
"data": {
"order_id": "v1-250513055632-aa-rjIIWX",
"merchant_order_reference": "bc2ddc75-eebb-452c-a034-ba9a836ddf17",
"type": "CHARGE",
"status": "PROCESSED",
"merchant_id": "111370",
"order_amount": {
"value": 21000,
"currency": "INR"
},
"pre_auth": false,
"allowed_payment_methods": [
"CARD",
"UPI",
"NETBANKING",
"POINTS",
"WALLET"
],
"notes": "order1",
"purchase_details": {
"customer": {
"email_id": "[email protected]",
"first_name": "Kevin",
"last_name": "Bob",
"customer_id": "192212",
"country_code": "91",
"mobile_number": "9876543210",
"billing_address": {},
"shipping_address": {
"address1": "H.No 15, Sector 17",
"address2": "",
"address3": "",
"pincode": "144001123",
"city": "CHANDIGARH",
"state": "PUNJAB",
"country": "INDIA"
},
"is_edit_customer_details_allowed": false
},
"merchant_metadata": {
"key1": "DD",
"key2": "XOF"
},
"split_info": {
"split_type": "AMOUNT",
"split_details": [
{
"split_merchant_id": "111370",
"split_settlement_id": "v1-250513055632-aa-rjIIWX-ss-f",
"amount": {
"value": 10000,
"currency": "INR"
},
"on_hold": false,
"status": "RELEASED",
"updated_at": "2025-05-13T05:58:15.960Z",
"release_amount": {
"value": 10000,
"currency": "INR"
}
},
{
"split_merchant_id": "111370",
"split_settlement_id": "v1-250513055632-aa-rjIIWX-ss-g",
"amount": {
"value": 2000,
"currency": "INR"
},
"on_hold": true,
"status": "HOLD",
"updated_at": "2025-05-13T05:56:32.655Z"
},
{
"split_merchant_id": "111370",
"split_settlement_id": "v1-250513055632-aa-rjIIWX-ss-h",
"amount": {
"value": 8000,
"currency": "INR"
},
"on_hold": true,
"status": "HOLD",
"updated_at": "2025-05-13T05:56:32.655Z"
},
{
"split_merchant_id": "111370",
"split_settlement_id": "v1-250513055632-aa-rjIIWX-ss-i",
"amount": {
"value": 500,
"currency": "INR"
},
"on_hold": true,
"status": "HOLD",
"updated_at": "2025-05-13T05:56:32.655Z"
},
{
"split_merchant_id": "111370",
"split_settlement_id": "v1-250513055632-aa-rjIIWX-ss-j",
"amount": {
"value": 500,
"currency": "INR"
},
"on_hold": false,
"status": "RELEASED",
"updated_at": "2025-05-13T05:56:32.655Z"
}
]
}
},
"payments": [
{
"id": "v1-250513055632-aa-rjIIWX-cc-a",
"merchant_payment_reference": "d1ec1a52-45fb-47be-bd7a-0e0d930f26b8",
"status": "PROCESSED",
"payment_amount": {
"value": 21000,
"currency": "INR"
},
"payment_method": "CARD",
"payment_option": {
"card_data": {
"card_type": "CREDIT",
"network_name": "VISA",
"issuer_name": "HDFC",
"card_category": "",
"country_code": "IND",
"token_txn_type": "ALT_TOKEN",
"last4_digit": "1091",
"save": false,
"is_native_otp_eligible": true
}
},
"acquirer_data": {
"approval_code": "831000",
"acquirer_reference": "7471158294616880303814",
"rrn": "513205569234",
"is_aggregator": true
},
"created_at": "2025-05-13T05:56:56.703Z",
"updated_at": "2025-05-13T05:57:10.422Z"
}
],
"created_at": "2025-05-13T05:56:32.655Z",
"updated_at": "2025-05-13T05:58:15.963Z",
"integration_mode": "SEAMLESS",
"payment_retries_remaining": 9
}
}
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 |
merchant_order_reference | string | Unique identifier entered while creating a order.
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. |
notes | string | The note you want to show against an order. Example: Order1 |
pre_auth | boolean | The pre-authorization type. Possible values:
false Learn more about our pre authorization. |
allowed_payment_methods | array of strings | The type of payment methods you want to offer your customers to accept payments. Accepted values:
CARD Note: Before selecting a payment method, ensure it is configured for you. |
callback_url | string | Use this URL to redirect your customers to specific success or failure pages based on the order or product details. Example: https\://sample-callback-url |
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 order request was received by Plural. Example: 2024-07-09T07:57:08.022Z |
updated_at | string | The ISO 8601 UTC Timestamp, when the order object is updated. Example: 2024-07-09T07:57:08.022Z |
integration_mode | string | Mode of Implementation. Possible values:
|
payment_retries_remaining | string | Remaining attempts to initiate a payment. Example: 9 |
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 |
country_code | string | Country code of the mobile number. Example: 91 |
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. |
is_edit_customer_details_allowed | boolean | Status of the customer details edit options. Possible values:
|
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 |
---|---|---|
split_merchant_id | string | Unique identifier of your partner merchant in the Plural database. Example: 123456 |
split_settlement_id | string | Unique identifier of the split settlement in the Plural database.
71124-aa-mpLhF3-cc-l Note: Use this Settlement ID to initiate a release a settlement using our Release Settlement API. |
amount | object | An object that contains the split amount details. Learn more about the amount child object. |
on_hold | boolean | Indicate whether the settlement is on hold for future release. Accepted values:
|
status | string | Split Settlement status. Possible values:
|
updated_at | string | The ISO 8601 UTC Timestamp, when the split order was created by Plural. Example: 2024-07-09T07:57:08.022Z |
release_amount | object | An object that contains the release amount details. Learn more about the release_amount child object. |
Amount [Child Object]
The table below lists the various parameters in the amount
child object. This object is part of the split_details
object.
Parameter | Type | Description |
---|---|---|
value | integer | The split amount is Paisa.
100 |
currency | string | Type of currency. Example: INR |
Release Amount [Child Object]
The table below lists the various parameters in the release_amount
child object. This object is part of the split_details
object.
Parameter | Type | Description |
---|---|---|
value | integer | The split amount is Paisa.
100 |
currency | string | Type of currency. Example: INR |
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 |
payment_option | object | An object that contains the details of the payment options. Learn more about our payment_option child object. |
acquirer_data | object | An object that contains the details of the acquirer data. Learn more about our acquirer_data child object. |
capture_data | object | An object that contains the details of the capture data. Learn more about our capture_data child object.Note: The presence of the key-value pairs against this object depends on the pre-authorization type. |
additional_detail | object | An object that contains the additional details related to the payment. Learn more about our capture_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 |
Payment Option [Child Object]
The table below lists the various parameters in the payment_option
child object. This object is part of the payments
object.
Parameter | Type | Description |
---|---|---|
card_data | object | An object that contains the card details. Learn more about our card_data child object. |
Card Data [Child Object]
The table below lists the various parameters in the card_data
child object. This object is part of the payment_option
object.
Parameter | Type | Description |
---|---|---|
card_type | string | Type of card. Possible values:
CREDIT |
network_name | string | Card network providers. Example: VISA |
issuer_name | string | Card issuer entity. Example: HDFC |
product_name | string | Card name. Example: Visa Platinum |
card_category | string | The card category type. Possible values:
|
country_code | string | Card issuers Country. Example: IND |
token_txn_type | string | Transaction token type. Possible values:
ALT_TOKEN |
last4_digit | string | Card last four digits. Example: 1091 |
save | boolean | Indicates the status of the customer's consent to save their card details for future transactions securely. Possible values:
|
is_native_otp_eligible | boolean | Status of Native OTP eligibility. Possible values:
|
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:
|
Capture Data [Child Object]
The table below lists the various parameters in the capture_data
child object. This object is part of the payments
object.
Parameter | Type | Description |
---|---|---|
merchant_capture_reference | string | Unique identifier passed while creating the capture payment request.
5742ef1e-4606-4c11-5757-705f4d415b6d |
capture_amount | object | An object that contains the capture amount details. Learn more about our capture_amount child object. |
created_at | string | The ISO 8601 UTC Timestamp, when the amount is captured. Example: 2024-07-11T11:52:12.484105Z |
Capture Amount [Child Object]
The table below lists the various parameters in the capture_amount
child object. This object is part of the capture_data
object.
Parameter | Type | Description |
---|---|---|
value | integer | The transaction amount is Paisa.
100 |
currency | string | Type of currency. Example: INR |
Additional Detail [Child Object]
The table below lists the various parameters in the additional_detail
child object. This object is part of the payments
object.
Parameter | Type | Description |
---|---|---|
source_ip | string | The IP Address of the merchant. Example: 52.66.76.63 |