Object

Shown below is a sample response for a Create Payment API using the Wallet method.

{
  "data": {
    "order_id": "v1-241108065317-aa-zqaZCr",
    "merchant_order_reference": "d1bc3469-672b-478f-b935-b385dda1a3a0",
    "type": "CHARGE",
    "status": "PENDING",
    "challenge_url": "https://api.pluralpay.in/web/auth/wallet/billdesk?token=v1-241114140627-aa-8Ujllu-wa-C",
    "merchant_id": "110553",
    "order_amount": {
      "value": 100,
      "currency": "INR"
    },
    "pre_auth": false,
    "callback_url":"https://sample-callback-url",
    "failure_callback_url": "https://sample-failure-callback-url",
    "allowed_payment_methods":[
      "CARD",
      "UPI",
      "NETBANKING",
      "POINTS",
      "WALLET"
    ],
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "192212",
        "mobile_number": "9876543210",
				"country_code": "91",
        "billing_address": {
          "address1": "H.No 15, Sector 17",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "",
          "address3": "",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        }
      },
      "merchant_metadata": {
        "key1": "DD",
        "key2": "XOF"
      }
    },
    "payments": [
      {
        "id": "v1-241108065317-aa-zqaZCr-nb-T",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "status": "PENDING",
        "payment_amount": {
          "value": 100,
          "currency": "INR"
        },
        "payment_method": "WALLET",
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "USBI0001265227",
          "rrn": "",
          "is_aggregator": true
        },
        "created_at": "2024-11-08T06:53:32.527Z",
        "updated_at": "2024-11-08T06:53:33.271Z"
      }
    ],
    "created_at": "2024-11-08T06:53:17.603Z",
    "updated_at": "2024-11-08T06:53:33.272Z",
    "integration_mode": "SEAMLESS"
  }
}

The table below lists the various parameters returned in the payments response object.

Parameter	Type	Description
order_id	`string`	Unique identifier of the order in the Pine Labs Online database. Example: `v1-241108065317-aa-zqaZCr`
merchant_order_reference	`string`	Unique identifier entered while creating a order. Minimum length: 1 character. Maximum length: 50 characters. Example: `d1bc3469-672b-478f-b935-b385dda1a3a0`
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` URL to navigate your users to the checkout page.
merchant_id	`string`	Unique identifier of the merchant in Pine Labs Online database. Example: `123456`
order_amount	`object`	An object that contains the order amount details. Learn more about our `order_amount` child object.
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.. Note: Pre authorization is not supported for Net Banking.
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.
notes	`string`	The note you want to show against an order. Example: `Order1`
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`
failure_callback_url	`string`	The URL specifically used to redirect customers to a failure page based on the order or product details. Example: `https://sample-failure-callback-url` Note: If the `failure_callback_url` is not provided, customers will be redirected to the `callback_url` for both successful and failed transactions. If the `failure_callback_url` is provided, the `callback_url` will be used exclusively for successful transactions, while the `failure_callback_url` will be used for failed transactions. If neither URL is provided, the default URL configured during merchant onboarding will be used.
purchase_details	`object`	An object that contains the purchase details. Learn more about our `purchase_details` child object. Note: The presence of the key-values pairs in this object depends on the Input request.
payments	`array of objects`	An array of object that contains the payment details. Learn more about our `payments` child object. Note: Payments response object can vary based on the payment methods and payment status.
created_at	`string`	The ISO 8601 UTC Timestamp, when the create order request was received by Pine Labs Online. Example: `2024-11-08T06:53:17.603Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the order response object is updated. Example: `2024-11-08T06:53:33.272Z`
integration_mode	`string`	Type of integration. Accepted values: `SEAMLESS` Example: `SEAMLESS`

Order Amount [Child Object]

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

Parameter	Type	Description
value	`integer`	The transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100` (₹10 lakh). Example: `100`
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 payments sample response object.

Parameter	Type	Description
customer	`Object`	An object that contains the customer details. Learn more about our `customer` child object.
merchant_metadata	`object`	An object of key-value pair that can be used to store additional information. Example: `"key1": "DD"`

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 character. 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 Pine Labs Online 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 our `billing_address` child object.
shipping_address	`object`	An object that contains the shipping address details. Learn more about our `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. Maximum length: 10 characters. Example: `51524036`
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. Maximum length: 10 characters. Example: `51524036`
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 Pine Labs Online database. Maximum length: 50 characters. Example: `v1-241108065317-aa-zqaZCr-nb-T`
merchant_payment_reference	`string`	A unique Payment Reference id sent by merchant.<br Example: 008cf04b-a770-4777-854e-b1e6c1230609
status	`string`	Payment status. Possible values: `PENDING`: When the create payment API request is successfully received by Pine Labs Online. `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 Pine Labs Online. `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` `WALLET` `NETBANKING` Example: `WALLET`
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.
created_at	`string`	The ISO 8601 UTC Timestamp, when the create payment request was received by Pine Labs Online. Example: `2024-07-11T06:52:12.484Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the payment response object is updated. Example: `2024-07-11T06:59:38.260Z`

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`

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. Example: `030376`
acquirer_reference	`string`	Unique reference returned from acquirer for the payment. Example: `202455840588334`
rrn	`string`	Retrieval reference number returned from acquirer for the payment. Example: `419335023601`
is_aggregator	`boolean`	The selected aggregator model type. Accepted values: `true`: Pine Labs Online is responsible for settling funds related to this payment. `false`: Pine Labs Online is not responsible for settling funds related to this payment. Note: When the `is_aggregator` is set to true, Pine Labs Online 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 explaining the why the error occured. Example: `Transaction declined due to insufficient balance`