Object

Shown below are the sample response returned through our Orders APIs.

{
  "data": {
    "order_id": "v1-5757575757-aa-hU1rUd",
    "merchant_order_reference": "112345",
    "type": "CHARGE",
    "status": "CREATED",
    "challenge_url": "https://api.pluralpay.in/web/auth/landing/?token=S50xnInJvpcftOzmuGWUqnLpIe694YPGJiKL%2FdBh5Yl%2Bwb8giJrl6HoTvcKljRVZa3H",
    "merchant_id": "123456",
    "order_amount": {
      "value": 1100,
      "currency": "INR"
    },
    "pre_auth": true,
    "allowed_payment_methods":[
      "CARD",
      "UPI",
      "NETBANKING",
      "POINTS",
      "WALLET"
    ],
    "notes": "order1",
    "callback_url": "https://sample-callback-url",
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "123456",
        "mobile_number": "9876543210",
				"country_code": "91",
        "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": [],
    "created_at": "2024-07-09T07:57:08.022Z",
    "updated_at": "2024-07-09T07:57:08.022Z",
    "cart_coupon_discount_amount": {
      "value": 100,
      "currency": "INR"
    }
  }
}

{
  "data": {
    "order_id": "v1-5757575757-aa-hU1rUd",
    "merchant_order_reference": "f4548bbf-a029-43d3-9209-e3385c80b1e9",
    "type": "CHARGE",
    "status": "PROCESSED",
    "merchant_id": "123456",
    "order_amount": {
      "value": 1100,
      "currency": "INR"
    },
    "pre_auth": true,
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "232323",
        "mobile_number": "9876543210",
				"country_code": "91",
        "billing_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-1111071924-aa-zzSkOA-cc-G",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 1100,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "VISA",
            "issuer_name": "NONE",
            "card_category": "CONSUMER",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN",
            "last4_digit": "1091",
            "save": false,
            "is_native_otp_eligible": true
          }
        },
        "acquirer_data": {
          "approval_code": "000000",
          "acquirer_reference": "202456643801053",
          "rrn": "420145000226",
          "is_aggregator": true
        },
        "capture_data": [
          {
            "merchant_capture_reference": "f31d8c60-0dc8-4788-a577-5ced930cc175",
            "capture_amount": {
              "value": 1100,
              "currency": "INR"
            },
            "created_at": "2024-07-19T11:13:21.523516426Z"
          }
        ],
        "created_at": "2024-09-11T08:07:55.647Z",
        "updated_at": "2024-09-11T08:07:57.115Z"
      }
    ],
    "created_at": "2024-07-19T11:11:48.944Z",
    "updated_at": "2024-07-19T11:13:23.962Z",
    "cart_coupon_discount_amount": {
      "value": 100,
      "currency": "INR"
    }
  }
}

{
  "data": {
    "order_id": "v1-1207071124-aa-JI80eS",
    "merchant_order_reference": "dbe7e053-86a4-48a3-9250-002fe2f4c40c",
    "type": "CHARGE",
    "status": "FAILED",
    "merchant_id": "104359",
    "order_amount": {
      "value": 1000,
      "currency": "INR"
    },
    "pre_auth": false,
    "notes": "order1",
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Mahesh",
        "last_name": "kumar",
        "customer_id": "192212",
        "mobile_number": "192192883",
				"country_code": "91",
        "billing_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "payments": [
      {
        "id": "v1-1207071124-aa-JI80eS-cc-o",
        "status": "FAILED",
        "payment_amount": {
          "value": 1000,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "MASTERCARD",
            "issuer_name": "HDFC",
            "card_category": "NONE",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN",
            "last4_digit": "1091",
            "save": false,
            "is_native_otp_eligible": true
          }
        },
        "error_detail": {
          "code": "USER_AUTHENTICATION_FAILED",
          "message": "Consumer Authentication failed"
        },
        "created_at": "2024-09-11T08:07:55.647Z",
        "updated_at": "2024-09-11T08:07:57.115Z"
      }
    ],
    "created_at": "2024-07-11T07:12:33.341Z",
    "updated_at": "2024-07-11T07:13:21.089Z",
    "cart_coupon_discount_amount": {
      "value": 100,
      "currency": "INR"
    }
  }
}

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.
allowed_payment_methods	`array of strings`	The type of payment methods you want to offer your customers to accept payments. Accepted values: `CARD` `UPI` `POINTS` `NETBANKING` `WALLET` `CREDIT_EMI` `DEBIT_EMI` Example: `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`
cart_coupon_discount_amount	`object`	An object that contains the cart coupon discount amount details. Learn more about the `cart_coupon_discount_amount` child object.

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: `10` character. Maximum length: `20` characters. Example: `9876543210` Supported characters: `0-9`
country_code	`string`	Country code of the registered mobile number. Maximum length: `5` characters. Example: `91` Note: If the country code is not provided, it defaults to `91`.
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`

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`
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: `true`: The customer's consent is received to save the card details securely.. `false`: The customer's consent is not received to save the card details.
is_native_otp_eligible	`boolean`	Status of Native OTP eligibility. Possible values: `true`: Card is eligible. `false`: Card is not eligible.

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`

Cart Coupon Discount Amount [Child Object]

The table below lists the various parameters in the cart_coupon_discount_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`