Object

The table below lists the response objects received for the different Card Payment APIs.

Token API
Create Card Payment	Card Payment Response Object
Generate OTP	OTP Response Objects
Resend OTP	OTP Response Objects
Submit OTP	OTP Response Objects
Get Card Details	Get Card Details Response Object

Card Payment Response Object

Shown below are the sample responses returned through our Create Payments API when the payment method is CARD.

{
  "data": {
    "order_id": "v1-5206071124-aa-mpLhF3",
    "merchant_order_reference": "0342ef1e-4606-4c11-8640-705f4d415b6d",
    "type": "CHARGE",
    "status": "PROCESSED",
    "challenge_url": "https://api.pluralpay.in/web/auth/landing/?token=S50xnInJvpcftOzmuGWUqnLpIe694YPGJiKL%2FdBh5Yl%2Bwb8giJrl6HoTvcKljRVZa3H",
    "merchant_id": "104359",
    "order_amount": {
      "value": 1000,
      "currency": "INR"
    },
    "pre_auth": false,
    "allowed_payment_methods":[
      "CARD",
      "UPI",
      "NETBANKING",
      "POINTS",
      "WALLET"
    ],    
    "notes": "order1",
    "callback_url":"https://sample-callback-url",
    "failure_callback_url": "https://sample-failure-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": "value1",
        "key2": "value2"
      }
    },
    "payments": [
      {
        "id": "v1-5206071124-aa-mpLhF3-cc-l",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "status": "PROCESSED",
        "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
          }
        },
        "acquirer_data": {
          "approval_code": "030376",
          "acquirer_reference": "202455840588334",
          "rrn": "419335023601",
          "is_aggregator": true
        },
        "created_at": "2024-07-11T06:52:12.484Z",
        "updated_at": "2024-07-11T06:59:38.260Z"
      }
    ],
    "created_at": "2024-07-11T06:52:12.484Z",
    "updated_at": "2024-07-11T06:59:38.260Z"
  }
}

{
  "data": {
    "order_id": "v1-5206071124-aa-mpLhF3",
    "merchant_order_reference": "0342ef1e-4606-4c11-8640-705f4d415b6d",
    "type": "CHARGE",
    "status": "PROCESSED",
    "challenge_url": "https://api.pluralpay.in/web/auth/landing/?token=S50xnInJvpcftOzmuGWUqnLpIe694YPGJiKL%2FdBh5Yl%2Bwb8giJrl6HoTvcKljRVZa3H",
    "merchant_id": "104359",
    "order_amount": {
      "value": 1000,
      "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"
    ],    
    "notes": "order1",
    "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": "value1",
        "key2": "value2"
      }
    },
    "payments": [
      {
        "id": "v1-5206071124-aa-mpLhF3-cc-l",
        "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 1000,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_token_details": {
            "name": "Test",
            "last4_digit": "1091",
            "cvv": "123",
            "expiry_month": "01",
            "expiry_year": "2026",
            "token": "4000000000001091",
            "cryptogram": "wAAAAAAl9SX1HsAmWKSgqwAAAA",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "030376",
          "acquirer_reference": "202455840588334",
          "rrn": "419335023601",
          "is_aggregator": true
        },
        "created_at": "2024-07-11T06:52:12.484Z",
        "updated_at": "2024-07-11T06:59:38.260Z"
      }
    ],
    "created_at": "2024-07-11T06:52:12.484Z",
    "updated_at": "2024-07-11T06:59:38.260Z"
  }
}

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-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` URL to navigate your users 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 transaction 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..
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` 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-07-09T07:57:08.022Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the order response 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 payments sample response 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`

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-5206071124-aa-mpLhF3-cc-l`
merchant_payment_reference	`string`	A unique Payment Reference id sent by merchant. 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` 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.
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`

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`
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. 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`

Capture Data [Child Object]

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

OTP Response Objects

Shown below are the sample responses through our OTP APIs.

{
  "next": [
    "SUBMIT_OTP",
    "RESEND_OTP"
  ],
  "meta_data": {
    "resend_after": "180"
  }
}

{
  "status": "SUCCESS"
}

{
  "status": "SUCCESS",
  "next": [
    "SUBMIT_OTP",
    "RESEND_OTP"
  ],
  "meta_data": {
    "resend_after": "180"
  }
}

The table below lists the various parameters returned in our OTP APIs response object.

Parameter	Type	Description
next	`array of strings`	An array of strings that contains the details of the next steps. Possible values: `SUBMIT_OTP`: Use our Submit OTP API to submit the OTP. `RESEND_OTP`: Use our resend OTP API to resend OTP to the registered mobile number of your customer. `NONE`: When OTP verification fails for reasons such as exceeding the maximum retry attempts or entering an invalid OTP. Note: If the `next` parameter is returned as NONE, you must create a new payment for the existing order to proceed.
meta_data	`object`	An object that contains the metadata information. Learn more about the `meta_data` child object.
status	`string`	OTP Verification status. Possible values: `success`: When the OTP is successfully submitted and the payment is initiated. Note: The OTP submission status does not indicate the transaction status. To check the transaction status, use webhooks or the fetch order API.

Metadata [Child Object]

The table below lists the various parameters in the metadata child object. This object is part of the OTP APIs response object.

Parameter	Type	Description
resend_after	`string`	The time after which you can initiate the Resend OTP API. Time in seconds. Example: `180`

Get Card Details Response Object

Shown below is a sample response returned through our Get Card Details API.

{
  "card_payment_details":[
    {
      "card_network":"VISA",
      "card_issuer":"INTL HDQTRS-CENTER OWNED",
      "card_type":"CREDIT",
      "card_category":"NONE",
      "is_international_card":false,
      "is_native_otp_supported":true,
      "country_code":"IND",
      "currency":"INR",
      "is_currency_supported":true
    }
  ]
}

The table below lists the various parameters returned in our Get Card Details API response object.

Parameter	Type	Description
card_payment_details	`array of objects`	An array of objects that contains the card payment details. Learn more about our `card_payment_details` child object.

Card Payment Details [Child Object]

The table below lists the various parameters in the card_payment_details child object. This object is part of the Get Card Details API response object.

Parameter	Type	Description
card_network	`string`	Card network providers. Example: `VISA`
card_issuer	`string`	Card Issuing entity. Example: `HDFC`
card_type	`string`	Type of card. Possible values: `NONE` `DEBIT` `CREDIT` `PREPAID` `CIRRUS` `CHARGE_CARD` `COMMERCIAL_PREPAID` `COMMERCIAL_CREDIT` `COMMERCIAL_DEBIT` `CONSUMER` `DEFERRED_DEBIT` `OTHER` Example: `CREDIT`
card_category	`string`	The card category type. Possible values: `CONSUMER` `COMMERCIAL` `PREMIUM` `SUPER_PREMIUM` `PLATINUM` `OTHER` `BUSINESS` `GOVERNMENT_NOTES` `PAYOUTS` `ELITE` `STANDARD` `NONE`
is_international_card	`boolean`	Status of the card classified as domestic or international. Possible values: `true`: The card is not issued from Indian Issuer Banks.[International Card] `false`: The card is issued from the Indian Issuer Bank.[Domestic Card]
is_native_otp_supported	`boolean`	Native OTP supported status. Possible values: `true`: Card supports native OTP. `false`: Card do not support native OTP.
country_code	`string`	Card issuers Country. Example: `IND`
currency	`string`	Type of currency. Example: `INR`
is_currency_supported	`boolean`	Currency support status. Possible values: `true`: Card supports dynamic currency conversion. `false`: Card do not support dynamic currency conversion.