Object

Shown below is a sample response of a Release Settlement Fee API.

{
  "data": {
    "order_id": "v1-241118174248-aa-81BMcH",
    "merchant_order_reference": "76d3327d-4aa2-4303-be51-e051180f3b99",
    "type": "CHARGE",
    "status": "PROCESSED",
    "merchant_id": "108272",
    "order_amount": {
      "value": 50000,
      "currency": "INR"
    },
    "pre_auth": false,
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
        "billing_address": {},
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      },
      "split_info": {
        "split_type": "AMOUNT",
        "split_details": [
          {
            "split_merchant_id": "123456",
            "split_settlement_id": "v1-241118174248-aa-81BMcH-ss-b",
            "merchant_settlement_reference": "kshjhfk",
            "amount": {
              "value": 20000,
              "currency": "INR"
            },
            "on_hold": false,
            "status": "RELEASED",
            "updated_at": "2024-11-18T07:49:38.212311Z"
          },
          {
            "split_merchant_id": "234567",
            "split_settlement_id": "v1-241118174248-aa-81BMcH-ss-r",
            "amount": {
              "value": 30000,
              "currency": "INR"
            },
            "on_hold": false,
            "status": "RELEASED",
            "updated_at": "2024-11-18T07:48:45.324348Z"
          }
        ]
      }
    },
    "payments": [
      {
        "id": "v1-241118174248-aa-81BMcH-cc-v",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 50000,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "VISA",
            "issuer_name": "U.S. REGION",
            "card_category": "Consumer",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "000000",
          "acquirer_reference": "202467869455141",
          "rrn": "431323000215",
          "is_aggregator": true
        },
        "created_at": "2024-11-18T07:48:48.233526Z",
        "updated_at": "2024-11-18T07:48:56.352361Z"
      }
    ],
    "created_at": "2024-11-18T07:48:45.324336Z",
    "updated_at": "2024-11-18T07:48:45.324348Z",
    "integration_mode": "SEAMLESS"
  }
}

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. Maximum length: 50 characters. Example: `v1-5757575757-aa-hU1rUd`
merchant_order_reference	`string`	Unique identifier entered while creating a order. Minimum length: 1 character. Maximum length: 50 characters. Example: `82d57572-057c-4826-5775-385a52150554`
type	`string`	Payment type. Possible values: `CHARGE` `REFUND`
status	`string`	Order status. Possible values: `CREATED`: When the order is successfully created. `PENDING`: When the order is linked against a payment request. `PROCESSED`: When the payment is received successfully. `AUTHORIZED`: Only when `pre_auth` is `true`. When the payment is ready for authorization. `CANCELLED`: When the payment gets cancelled. `ATTEMPTED`: When the payment is unsuccessful due to incorrect OTP. You can retry OTP verification until the payment gets failed. `FAILED`: Payment acceptance failed for reasons such as cancel transactions, maximum retries for OTP verification etc. `FULLY_REFUNDED`: When the payment is completely refunded. `PARTIALLY_REFUNDED`: When the partial refund is successful.
challenge_url	`string`	Use the generated `challenge_url` to accept payment. Note: This parameter is returned only after the payment is linked against the `order_id`.
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: `true`: When pre-authorization is needed. `false`: When pre-authorization is not required. Example: `false` Learn more about our pre authorization.
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`

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. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `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.

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. Minimum length: 1 character. Maximum length: 50 characters. Example: `[email protected]`
first_name	`string`	Customer's first name. Minimum length: 1 character. Maximum length: 50 characters. Example: `Kevin`
last_name	`string`	Customer's last name. Minimum length: 1 character. Maximum length: 50 characters. Example: `Bob`
customer_id	`string`	Unique identifier of the customer in the Plural database. Minimum length: 1 character. Maximum length: 19 characters. Example: `123456`
mobile_number	`string`	Customer's mobile number. Minimum length: 9 character. Maximum length: 20 characters. Example: `9876543210` Supported characters: `0-9` `+`
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. Maximum length: 100 characters. Example: `10 Downing Street Westminster London`
address2	`string`	Customer's billing address2. Maximum length: 100 characters. Example: `Oxford Street Westminster London`
address3	`string`	Customer's billing address3. Maximum length: 100 characters. Example: `Baker Street Westminster London`
pincode	`string`	Pincode of the billing address. Minimum length: 6 characters. Maximum length: 10 characters. Example: `51524036` Supported characters: `0-9`
city	`string`	City of the billing address. Maximum length: 50 characters. Example: `Westminster`
state	`string`	State of the billing address. Maximum length: 50 characters. Example: `Westminster`
country	`string`	Country of the billing address. Maximum length: 50 characters. Example: `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. Maximum length: 100 characters. Example: `10 Downing Street Westminster London`
address2	`string`	Customer's shipping address2. Maximum length: 100 characters. Example: `Oxford Street Westminster London`
address3	`string`	Customer's shipping address3. Maximum length: 100 characters. Example: `Baker Street Westminster London`
pincode	`string`	Pincode of the shipping address. Minimum length: 6 characters. Maximum length: 10 characters. Example: `51524036` Supported characters: `0-9`
city	`string`	City of the shipping address. Maximum length: 50 characters. Example: `Westminster`
state	`string`	State of the shipping address. Maximum length: 50 characters. Example: `Westminster`
country	`string`	Country of the shipping address. Maximum length: 50 characters. Example: `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.

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`	Partner merchant ID. Example: `123456`
merchant_settlement_reference	`string`	Unique identifier entered while creating a order in split. Maximum length: 50 characters. Example: `5206071124-aa-mpLhF3-cc-l`
split_settlement_id	`string`	Unique identifier of the split settlement in the Plural database. Maximum length: 50 characters. Example: `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: `true`: The settlement is placed on hold. `false`: The settlement is processed immediately.
status	`string`	Split Settlement status. Possible values: `RELEASED` `HOLD`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the split order was created by Plural. Example: `2024-07-09T07:57:08.022Z`

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. Minimum value: `100` (₹1). Maximum value: `100000000` (₹10 lakh). Example: `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. Maximum length: 50 characters. Example: `v1-5206071124-aa-mpLhF3-cc-l`
status	`string`	Payment status. Possible values: `PENDING`: When the create payment API request is successfully received by Plural. `AUTHORIZED`: Only when `pre_auth` is `true`. When the payment is ready for authorization. `CANCELLED`: When the payment gets cancelled. `PROCESSED`: When the payment is successfully received by Plural. `FAILED`: When the payment fails, this can be for many reasons such as canceling payments, etc. Example: `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` `UPI` `POINTS` Example: `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.
error_detail	`object`	An object that contains the error details. Learn more about our `error_detail` child object. Note: This object is returned only for the failed payment.
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. Minimum value: `100` (₹1). Maximum value: `100000000` (₹10 lakh). Example: `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: `DEBIT` `CREDIT` Example: `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: `CONSUMER` `COMMERCIAL` `PREMIUM` `SUPER_PREMIUM` `PLATINUM` `OTHER` `BUSINESS` `GOVERNMENT_NOTES` `PAYOUTS` `ELITE` `STANDARD`
country_code	`string`	Card issuers Country. Example: `IND`
token_txn_type	`string`	Transaction token type. Possible values: `ALT_TOKEN` `NETWORK_TOKEN` `ISSUER_TOKEN` Example: `ALT_TOKEN`

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. Maximum length: 50 characters. Example: `030376`
acquirer_reference	`string`	Unique reference returned from acquirer for the payment. Maximum length: 50 characters. Example: `202455840588334`
rrn	`string`	Retrieval reference number returned from acquirer for the payment. Maximum length: 50 characters. Example: `419335023601`
is_aggregator	`boolean`	The selected aggregator model type. Accepted values: `true`: Plural is responsible for settling funds related to this payment. `false`: Plural is not responsible for settling funds related to this payment. Note: When the `is_aggregator` is set to true, Plural acts as the acquirer on behalf of merchants, receiving funds from banks into a designated "Nodal Account". When the `is_aggregator` is set to false, the Merchant has a direct relationship with the bank and the responsibility for settlement of funds lies with both of those parties.

Error Detail [Child Object]

The table below lists the various parameters in the error_detail child object. This object is part of the payments object.

Parameter	Type	Description
code	`string`	The error short Code. Example: `PAYMENT_DECLINED`
message	`string`	Error description. This parameter tells you why the error occurred. Example: `Transaction declined due to insufficient balance`

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. Minimum length: 1 character. Maximum length: 50 characters. Example: `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. Minimum value: `100` (₹1). Maximum value: `100000000` (₹10 lakh). Example: `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`