Product Guides

Integration Steps - Seamless Checkout

Learn how you can integrate with Pine Labs Online APIs to start accepting payments on your website.

Follow the below steps to integrate with Pine Labs Online seamless checkout APIs in your application.

  1. [Prerequisite] Generate Token
  2. Check Point Balance API
  3. Create Order
  4. Create Payment
  5. Handle Payment
    1. Store Payment Details on Your Server
    2. Verify Payment Signature
  6. Capture Order
  7. Cancel Order

📘

Note

  • Ensure you store your Client ID and Secret in your Backend securely.
  • Integrate our APIs on your backend system.
  • We strictly recommend not to call our APIs from the frontend.
  • Failure to adhere to the above guidelines may result in legal implications. In such cases, you will be held responsible for any damage or loss arising from non-compliance.

1. [Prerequisite] Generate Token

🚧

Watch Out

  • To Integrate with Pine Labs Online seamless checkout flow you must have a PCI compliance certificate.

Integrate our Generate Token API in your backend servers to generate the access token. Use the token generated to authenticate Pine Labs Online APIs.

Below are the sample requests and response for the Generate Token API.

curl --location 'https://pluraluat.v2.pinepg.in/api/auth/v1/token' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--data '
{
  "client_id": "a17ce30e-f88e-4f81-ada1-c3b4909ed232",
  "client_secret": "fgwei7egyhuggwp39w8rh",
  "grant_type": "client_credentials"
}
'

curl --location 'https://api.pluralpay.in/api/auth/v1/token' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--data '
{
  "client_id": "a17ce30e-f88e-4f81-ada1-c3b4909ed232",
  "client_secret": "fgwei7egyhuggwp39w8rh",
  "grant_type": "client_credentials"
}
'

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "expires_in": 3600
}
Click here for request and response parameter information.
Request Parameters
Response Parameters

The table below lists the request parameters of our Generate Token API.

Parameter Type Description
client_id required string Unique client identifier in the Pine Labs Online database.

Example: a17ce30e-f88e-4f81-ada1-c3b4909ed232

Note: The Onboarding team has provided you with this information as part of the onboarding process.
client_secret required string Unique client secret key provided while onboarding.

Example: fgwei7egyhuggwp39w8rh

Note: The Onboarding team has provided you with this information as part of the onboarding process.
grant_type required string The grant type to generate an access token.

Accepted value: client_credentials

The table below lists the response parameters of our Generate Token API.

Parameter Type Description
access_token string The access token generated by the system.

• Minimum length: 1 character.
• Maximum length: 8192 characters.

Example: eyJhbGciOiJIUzI1NiIsIn

Note: Use this token in the authorization headers to authenticate Pine Labs Online APIs.
expires_at string Access duration timestamp.

Example: 2024-06-28T13:26:06.909140Z

Refer to our Generate Token API documentation to learn more.

2. Check Point Balance API

Use this API to check the Point balance and eligibility.

To authenticate this API, use the generated access token in the Authorization headers of the API request.

Below are the sample requests and response for a Payment Option API

curl --request POST \
     --url https://pluraluat.v2.pinepg.in/payment-option \
     --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
     --header 'Content-Type: application/json' \
     --header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
     --header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
     --header 'accept: application/json' \
     --data '
{
  "payment_option": {
    "points_card_details": {
      "card_last4": "1112",
      "card_number": "4012001037141112",
      "registered_mobile_number": "7827709063"
    }
  },
  "order_details": {
    "order_amount": {
      "value": 5000,
      "currency": "INR"
    }
  }
}
'

curl --request POST \
     --url https://api.pluralpay.in/payment-option \
     --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
     --header 'Content-Type: application/json' \
     --header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
     --header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
     --header 'accept: application/json' \
     --data '
{
  "payment_option": {
    "points_card_details": {
      "card_last4": "1112",
      "card_number": "4012001037141112",
      "registered_mobile_number": "7827709063"
    }
  },
  "order_details": {
    "order_amount": {
      "value": 5000,
      "currency": "INR"
    }
  }
}
'

{
  "balance": {
    "value": 23718050,
    "currency": "INR"
  },
  "redeemable_amount": {
    "value": 3500,
    "currency": "INR"
  },
  "redeemable_points": 140,
  "is_eligible": true
}
Click here for request and response parameter information.
Request Parameters
Response Parameters

The table below lists the request parameters of our Check Point Balance API.

Parameter Type Description
payment_option required object An object that contains the details of the payment options.

Learn more about the payment optionchild object.
order_details required object An object that contains the order details.

Learn more about the order details child object.

Payment Option [Child Object]

The table below lists the various parameters in the payment_option child object. This object is part of the Check Point Balance request object.

Parameter Type Description
points_card_details required object An object that contains the point card details.

Learn more about the points_card_details child object.

Order Details [Child Object]

The table below lists the various parameters in the order_details child object. This object is part of the Check Point Balance request object.

Parameter Type Description
order_amount required object An object that contains the order amount details.

Learn more about the order_amount child object.

Points Card Details [Child Object]

The table below lists the various parameters in the points_card_details child object. This object is part of the payment_option object.

Parameter Type Description
card_last4 required string The last four digits of your card number.

Has to be 4 digits.

Example: `1234`

Supported characters: 0-9
card_number required string Card Number.
  • Maximum length: 23 characters.
  • Minimum length: `12` characters.
Example: 123456789012

Supported characters: 0-9
registered_mobile_number required string Point card registered mobile number.
  • Maximum length: 20 characters.
  • Minimum length: 9 characters.
Example: 9876543210

Supported characters:
  • 0-9
  • +

Order Amount [Child Object]

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

Parameter Type Description
value required integer The transaction amount is in Paisa.

Minimum value: 100 (₹1).
Maximum value: 100000000 (₹10 lakh).

Example: 100
currency required string Type of currency.

Example: INR

The table below lists the various parameters returned in the Check Point Balance response object.

Parameter Type Description
balance object An object that contains the card balance details.

Learn more about our balance child object.
redeemable_amount object An object that contains the redeemable amount details.

Learn more about our redeemable_amount child object.
redeemable_points integer Total redeemable points available in the card.

Example: 140
is_eligible boolean Card eligibility status.

Example: true

Balance [Child Object]

The table below lists the various parameters in the balance child object. This object is part of the check point balance sample response object.

Parameter Type Description
value integer Balance available on the card.

Example: 23718050
currency string Type of currency.

Example: INR

Redeemable Amount [Child Object]

The table below lists the various parameters in the redeemable_amount child object. This object is part of the check point balance sample response object.

Parameter Type Description
value integer Redeemable amount on card.

Example: 3500
currency string Type of currency.

Example: INR

Refer to our Check Point Balance API documentation to learn more.

👍

Customer consent before redeeming points

  • The Pay by Points option is not enabled by default.
  • Customers must explicitly provide consent to use their rewards or points as part of the payment for an order.
  • It is mandatory to obtain customer consent before redeeming their rewards/points in compliance with legal agreements established with our partner Banks.

3. Create Order

To create an Order, use our Create Order API, for authentication use the generated access token in the headers of the API request.

Below are the sample requests and response for a Create Order API.

curl --location 'https://pluraluat.v2.pinepg.in/api/pay/v1/orders' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
--header 'Content-Type: application/json' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'accept: application/json' \
--data '
{
  "merchant_order_reference":112345,
  "order_amount":{
    "value":1100,
    "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":"DD",
      "key2":"XOF"
    }
  }
}
'

curl --location 'https://api.pluralpay.in/api/pay/v1/orders' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
--header 'Content-Type: application/json' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'accept: application/json' \
--data '
{
  "merchant_order_reference":112345,
  "order_amount":{
    "value":1100,
    "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":"DD",
      "key2":"XOF"
    }
  }
}
'


{
  "data":{
    "order_id":"v1-4405071524-aa-qlAtAf",
    "merchant_order_reference":"112345",
    "type":"CHARGE",
    "status":"CREATED",
    "merchant_id":"104359",
    "order_amount":{
      "value":1100,
      "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":"DD",
        "key2":"XOF"
      }
    },
    "payments":[
      
    ],
    "created_at":"2024-07-15T05:44:51.174Z",
    "updated_at":"2024-07-15T05:44:51.174Z"
  }
}
Click here for request and response parameter information.
Request Parameters
Response Parameters

The table below lists the request parameters of our create order API.

Parameter Type Description
merchant_order_reference required string Enter a unique identifier for the order request.

  • Minimum: 1 character.
  • Maximum: 50 characters.
Example: 1234567890

Supported characters:
  • A-Z
  • a-z
  • 0-9
  • -
  • _
order_amount required object An object that contains the transaction amount details.

Learn more about the order_amount child object.
pre_auth boolean The pre-authorization type.

Possible values:
  • false (default): When pre-authorization is not required.
  • true: When pre-authorization is needed.
allowed_payment_methods array of strings The type of payment methods you want to offer customers.

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 Note to show against an order.

Example: Order1
callback_url string URL to redirect customers based on order details.

Example: https://sample-callback-url
purchase_details object An object that contains purchase details.

Learn more about the purchase_details 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 create order request object.

Parameter Type Description
value required integer Transaction amount in Paisa.

  • Minimum value: 100 (₹1).
  • Maximum value: 100000000 (₹10 lakh).
Example: 1000
currency required 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 create order request 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"

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 Pine Labs Online database.
  • Minimum length: 1 character.
  • Maximum length: 19 characters.
Example: 123456
mobile_number string Customer's mobile number.
  • Minimum length: 9 characters.
  • Maximum length: 20 characters.
Example: 9876543210
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
address1stringCustomer's billing address1.
  • Max length: 100 characters.
Example: 10 Downing Street Westminster London
address2stringCustomer's billing address2.
  • Max length: 100 characters.
Example: Oxford Street Westminster London
address3stringCustomer's billing address3.
  • Max length: 100 characters.
Example: Baker Street Westminster London
pincodestringPincode of the billing address.
  • Min length: 6 characters.
  • Max length: 10 characters.
Example: 51524036
citystringCity of the billing address.
  • Max length: 50 characters.
Example: Westminster
statestringState of the billing address.
  • Max length: 50 characters.
Example: Westminster
countrystringCountry of the billing address.
  • Max 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
address1stringCustomer's shipping address1.
  • Max length: 100 characters.
Example: 10 Downing Street Westminster London
address2stringCustomer's shipping address2.
  • Max length: 100 characters.
Example: Oxford Street Westminster London
address3stringCustomer's shipping address3.
  • Max length: 100 characters.
Example: Baker Street Westminster London
pincodestringPincode of the shipping address.
  • Min length: 6 characters
  • Max length: 10 characters.
Example: 51524036
citystringCity of the shipping address.
  • Max length: 50 characters.
Example: Westminster
statestringState of the shipping address.
  • Max length: 50 characters.
Example: Westminster
countrystringCountry of the shipping address.
  • Max length: 50 characters.
Example: London

The table below lists the various parameters returned in the Create order response objects.

Parameter Type Description
order_id string Unique identifier of the order in the Pine Labs Online database.
  • Max length: 50 characters.
Example: v1-5757575757-aa-hU1rUd
merchant_order_reference string Unique identifier entered while creating an order.
  • Min length: 1 character.
  • Max 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
  • 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 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.
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
allowed_payment_methods array of strings The type of payment methods you want to offer customers.

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 URL to redirect customers to success or failure pages.

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.

Note: Payment object is returned only for the orders linked with a payment.
created_at string The ISO 8601 UTC Timestamp when the order request was received.

Example: 2024-07-09T07:57:08.022Z
updated_at string The ISO 8601 UTC Timestamp when the order object was 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 create order response object.

Parameter Type Description
value integer Transaction amount in 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 create order 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"

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 Pine Labs Online database.
  • Minimum length: 1 character.
  • Maximum length: 19 characters.
Example: 123456
mobile_number string Customer's mobile number.
  • Minimum length: 9 characters.
  • Maximum length: 20 characters.
Example: 9876543210
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
address1stringCustomer's billing address1.
  • Max length: 100 characters.
Example: 10 Downing Street Westminster London
address2stringCustomer's billing address2.
  • Max length: 100 characters.
Example: Oxford Street Westminster London
address3stringCustomer's billing address3.
  • Max length: 100 characters.
Example: Baker Street Westminster London
pincodestringPincode of the billing address.
  • Min length: 6 characters.
  • Max length: 10 characters.
Example: 51524036
citystringCity of the billing address.
  • Max length: 50 characters.
Example: Westminster
statestringState of the billing address.
  • Max length: 50 characters.
Example: Westminster
countrystringCountry of the billing address.
  • Max 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
address1stringCustomer's shipping address1.
  • Max length: 100 characters.
Example: 10 Downing Street Westminster London
address2stringCustomer's shipping address2.
  • Max length: 100 characters.
Example: Oxford Street Westminster London
address3stringCustomer's shipping address3.
  • Max length: 100 characters.
Example: Baker Street Westminster London
pincodestringPincode of the shipping address.
  • Min length: 6 characters
  • Max length: 10 characters.
Example: 51524036
citystringCity of the shipping address.
  • Max length: 50 characters.
Example: Westminster
statestringState of the shipping address.
  • Max length: 50 characters.
Example: Westminster
countrystringCountry of the shipping address.
  • Max length: 50 characters.
Example: London

Refer to our Create Order API documentation to learn more.

4. Create Payment

To create a payment, use our Create Payment API, use the order_id returned in the response of a Create Order API to link the payment against an order.

Below are the sample requests and sample response for a Create Payment API via Points flow.

curl --location 'https://pluraluat.v2.pinepg.in/api/pay/v1/orders/{order_id}/payments' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
--header 'Content-Type: application/json' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'accept: application/json' \
--data '
{
  "payments": [
    {
      "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
      "payment_method": "CARD",
      "payment_amount": {
        "value": 1500,
        "currency": "INR"
      },
      "payment_option": {
        "card_details": {
          "name": "Kevin Bob",
          "card_number": "4012001037141112",
          "cvv": "123",
          "expiry_month": "12",
          "expiry_year": "2025",
          "registered_mobile_number": "9876543210"
        }
      }
    },
    {
      "payment_method": "POINTS",
      "payment_amount": {
        "value": 3500,
        "currency": "INR"
      },
      "payment_option": {
        "points_card_details": {
          "registered_mobile_number": "9876543210",
          "card_last4": "1112",
          "card_number": "4012001037141112"
        }
      }
    }
  ]
}
'

curl --location 'https://api.pluralpay.in/api/pay/v1/orders/{order_id}/payments' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
--header 'Content-Type: application/json' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'accept: application/json' \
--data '
{
  "payments": [
    {
      "merchant_payment_reference": "008cf04b-a770-4777-854e-b1e6c1230609",
      "payment_method": "CARD",
      "payment_amount": {
        "value": 1500,
        "currency": "INR"
      },
      "payment_option": {
        "card_details": {
          "name": "Kevin Bob",
          "card_number": "4012001037141112",
          "cvv": "123",
          "expiry_month": "12",
          "expiry_year": "2025",
          "registered_mobile_number": "9876543210"
        }
      }
    },
    {
      "payment_method": "POINTS",
      "payment_amount": {
        "value": 3500,
        "currency": "INR"
      },
      "payment_option": {
        "points_card_details": {
          "registered_mobile_number": "9876543210",
          "card_last4": "1112",
          "card_number": "4012001037141112"
        }
      }
    }
  ]
}
'

{
  "data":{
    "order_id":"v1-240902072711-aa-KAw3iP",
    "merchant_order_reference":"9bba427e-18c5-4645-9bd7-0cdb384371d7",
    "type":"CHARGE",
    "status":"PENDING",
    "challenge_url":"https://pluraluat.v2.pinepg.in/web/auth/landing/?token=S50%2BoHJmZ8ftKIhAKv%2BqQws3%2FkfY39tiuaMcSY15i%2BWH%2Bx4N6I%2B7lrNWbcM4Dl72hU6",
    "merchant_id":"109968",
    "order_amount":{
      "value":5000,
      "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":{
      
    },
    "payments":[
      {
        "id":"v1-240902072711-aa-KAw3iP-cc-g",
        "merchant_payment_reference":"008cf04b-a770-4777-854e-b1e6c1230609",
        "status":"PENDING",
        "payment_amount":{
          "value":1500,
          "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"
          }
        },
        "acquirer_data":{
          "approval_code":"",
          "acquirer_reference":"7252620755296724003954",
          "rrn":""
        },
      },
      {
        "id":"v1-240902072711-aa-KAw3iP-pt-P",
        "status":"PENDING",
        "payment_amount":{
          "value":3500,
          "currency":"INR"
        },
        "payment_method":"POINTS",
        "acquirer_data":{
          "approval_code":"",
          "acquirer_reference":"",
          "rrn":""
        },
        "created_at":"2024-09-02T07:27:11.240Z",
        "updated_at":"2024-09-02T07:27:52.950Z"
      }
    ],
    "created_at":"2024-09-02T07:27:11.240Z",
    "updated_at":"2024-09-02T07:27:52.950Z"
  }
}
Click here for request and response parameter information.
Request Parameters
Response Parameters

Path Parameter

The table below lists the path parameters of our Create Payment via Pay by Points API.

Parameter Type Description
order_id required string Unique identifier of the order in the Pine Labs Online database.

Example: v1-5757575757-aa-hU1rUd

Request Parameters

The table below lists the request parameters of our Create Payment via Pay by Points API.

Parameter Type Description
Payments required array of objects An array of objects that contains the payment details.

Learn more about our payments child object

Payments [Child Object]

The table below lists the various parameters in the payments child object. This object is part of the Create Payment via Pay by Points request object.

Parameter Type Description
merchant_payment_reference required string Unique Payment Reference id sent by merchant.

Example: 008cf04b-a770-4777-854e-b1e6c1230609
payment_method required string Type of payment method you want to use to accept a payment.

Accepted value:
  • POINTS
  • CARD

    Example: POINTS
payment_amount required object An object that contains the details of the payment amount.

Learn more about our payment_amount child object.
payment_option required object An object that contains the details of the payment options.

Learn more about our payment_option child object.

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 required integer The payment amount is Paisa.
  • Minimum value: 100 (₹1).
  • Maximum value: 100000000 (₹10 lakh).
Example: 100
currency required 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.

  • When the payment method is POINTS, the points_card_details object is mandatory.

    Parameter Type Description
    points_card_details object An object that contains the An object that contains the point card details.

    Learn more about the card_details child object.
    Points Card Details [Child Object]

    The table below lists the various parameters in the points_card_details child object. This object is part of the payment_option object.

    Parameter Type Description
    card_last4 required string The last four digits of your card number.

    Has to be 4 digits.

    Example: 1234

    Supported characters: 0-9
    card_number required string Card Number.
    • Maximum length: 23 characters.
    • Minimum length: 12 characters.
    Example: 123456789012

    Supported characters: 0-9
    registered_mobile_number required string Point card registered mobile number.
    • Maximum length: 20 characters.
    • Minimum length: 9 characters.
    Example: 9876543210

    Supported characters:
    • 0-9
    • +

    • The table below lists the various parameters returned in the Create Payment via Pay by Points response objects.

    Parameter Type Description
    order_id string Unique identifier of the order in the Pine Labs Online database.
    • Max length: 50 characters.
    Example: v1-5757575757-aa-hU1rUd
    merchant_order_reference string Unique identifier entered while creating an order.
    • Min length: 1 character.
    • Max 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
    • 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 the 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.
    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
    allowed_payment_methods array of strings The type of payment methods you want to offer customers.

    Accepted values:
    • CARD
    • UPI
    • POINTS
    • NETBANKING
    • WALLET
    • CREDIT_EMI
    • DEBIT_EMI
    Example: POINTS

    Note: Before selecting a payment method, ensure it is configured for you.
    callback_url string URL to redirect customers to success or failure pages.

    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 order request was received.

    Example: 2024-07-09T07:57:08.022Z
    updated_at string The ISO 8601 UTC Timestamp when the order object was 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 create order request object.

    Parameter Type Description
    value integer Transaction amount in 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 create order request 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"

    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 Pine Labs Online database.
    • Minimum length: 1 character.
    • Maximum length: 19 characters.
    Example: 123456
    mobile_number string Customer's mobile number.
    • Minimum length: 9 characters.
    • Maximum length: 20 characters.
    Example: 9876543210
    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
    address1stringCustomer's billing address1.
    • Max length: 100 characters.
    Example: 10 Downing Street Westminster London
    address2stringCustomer's billing address2.
    • Max length: 100 characters.
    Example: Oxford Street Westminster London
    address3stringCustomer's billing address3.
    • Max length: 100 characters.
    Example: Baker Street Westminster London
    pincodestringPincode of the billing address.
    • Min length: 6 characters.
    • Max length: 10 characters.
    Example: 51524036
    citystringCity of the billing address.
    • Max length: 50 characters.
    Example: Westminster
    statestringState of the billing address.
    • Max length: 50 characters.
    Example: Westminster
    countrystringCountry of the billing address.
    • Max 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
    address1stringCustomer's shipping address1.
    • Max length: 100 characters.
    Example: 10 Downing Street Westminster London
    address2stringCustomer's shipping address2.
    • Max length: 100 characters.
    Example: Oxford Street Westminster London
    address3stringCustomer's shipping address3.
    • Max length: 100 characters.
    Example: Baker Street Westminster London
    pincodestringPincode of the shipping address.
    • Min length: 6 characters
    • Max length: 10 characters.
    Example: 51524036
    citystringCity of the shipping address.
    • Max length: 50 characters.
    Example: Westminster
    statestringState of the shipping address.
    • Max length: 50 characters.
    Example: Westminster
    countrystringCountry of the shipping address.
    • Max 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.
    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 issuer's 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.

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

    Refer to our Create Payment API documentation to learn more.

    👍

    Check Point Balance/Eligibility

    • Your order may fail if the payment split between card and points is incorrect during payment initiation.
    • For example, if the total order amount is Rs. 45.73 and the redeemable amount through points is Rs. 32.01, you should initiate a payment of Rs. 13.72 via card and Rs. 32.01 through points.

    📘

    Note:

    When the pre-authorization is set to true you can capture the payment after successful delivery or service.

    5. Handle Payment

    In create payment API response we return a challenge_url, use this challenge url to navigate your customers to the checkout page to accept payment.

    📘

    Note:

    • On successful payment we send the webhook event ORDER_AUTHORIZED and the status of the payment is updated to authorized.
    • You can capture or cancel an order only when the order status is authorized.

    5.1 Store Payment Details on Your Server

    On a successful and failed payment, we return the following fields to the return url.

    • We recommend you to store the payment details on your server.
    • You must validate the authenticity of the payment details returned. You can authenticate by verifying the signature.
    {
  "order_id": "v1-4405071524-aa-qlAtAf",
  "payment_status": "AUTHORIZED",
  "signature": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
}

    {
  "order_id": "v1-4405071524-aa-qlAtAf",
  "payment_status": "AUTHORIZED",
  "error_code": "USER_AUTHENTICATION_REQUIRED",
  "error_message": "Consumer Authentication Required",
  "signature": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
}

    5.2 Verify Payment Signature

    Ensure you follow this as a mandatory step to verify the authenticity of the details returned to the checkout form for successful payments.

    Follow the below steps to verify the signature.

    1. Create a signature on your server using the following parameters using the SHA256 algorithm.
      1. order_id: Unique Identifier generated for an order request on Pine Labs Online database.
      2. payment_status: Payment status.
      3. error_code: Short code for the error returned.
      4. error_message: Corresponding error message for the code.
      5. secret_key: The Onboarding team has provided you with this information as part of the onboarding process.

    Use the below sample code to construct HashMap signature using the SHA256 algorithm.

    import java.io.UnsupportedEncodingException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
 
public class hash {
    public static void main(String[] args) {
        // Test the GenerateHash method
        String input = "<string>";
        String secretKey = "<secret_key>";  // Example key in hex
 
        String hash = GenerateHash(input, secretKey);
        System.out.println("Generated Hash: " + hash);
    }
    public static String GenerateHash(String input, String strSecretKey) {
        String strHash = "";
        try {
            if (!isValidString(input) || !isValidString(strSecretKey)) {
                return strHash;
            }
            byte[] convertedHashKey = new byte[strSecretKey.length() / 2];
 
            for (int i = 0; i < strSecretKey.length() / 2; i++) {
                convertedHashKey[i] =
                        (byte)Integer.parseInt(strSecretKey.substring(i * 2, (i*2)+2),16); //hexNumber radix
            }
            strHash = hmacDigest(input.toString(), convertedHashKey,
                    "HmacSHA256");
        } catch (Exception ex) {
            strHash = "";
        }
        return strHash.toUpperCase();
    }
    private static String hmacDigest(String msg, byte[] keyString, String algo) {
        String digest = null;
        try {
            SecretKeySpec key = new SecretKeySpec(keyString, algo);
            Mac mac = Mac.getInstance(algo);
            mac.init(key);
            byte[] bytes = mac.doFinal(msg.getBytes("UTF-8"));
            StringBuffer hash = new StringBuffer();
            for (int i = 0; i < bytes.length; i++) {
                String hex = Integer.toHexString(0xFF & bytes[i]);
                if (hex.length() == 1) {
                    hash.append('0');
                }
                hash.append(hex);
            }
            digest = hash.toString();
        } catch (UnsupportedEncodingException e) {
// logger.error("Exception occured in hashing the pine payment gateway request"+e);
        } catch (InvalidKeyException e) {
// logger.error("Exception occured in hashing the pine payment gateway request"+e);
        } catch (NoSuchAlgorithmException e) {
// logger.error("Exception occured in hashing the pine payment gateway request"+e);
        }
        return digest;
    }
    public static boolean isValidString(String str){
        if(str != null && !"".equals(str.trim())){
            return true;
        }
        return false;
    }
}

    📘

    Note:

    To create a request string, format the key-value pairs of data returned to the return URL. The pairs are separated by & and arranged in ascending order based on a lexicographical comparison of the keys.

    Shown below is a example to create a request string.

    "key1=value1&key2=value2", ["order_id=random_order_id&status=AUTHORIZED"]

    "key1=value1&key2=value2&key3=value3&key4=value4", ["error_code=USER_AUTHENTICATION_FAILED&error_message=Consumer Authentication required&order_id=<order_id>&status=FAILED"]
    1. If the signature generated on your server matches the Pine Labs Online signature returned in the return URL, it confirms that the payment details are from Pine Labs Online.
    2. Capture the status returned on your database. Once the payment status is AUTHORIZED you can either capture or cancel an order.

    6. Capture Order

    📘

    Important:

    • With pre-authorization set to true, you can capture or cancel a payment for an order.

    Use this API to capture the payment against an order. On successful capture of an order the order status is updated as processed.

    Shown below are the sample requests and sample response for a Capture Order API.

    curl --request PUT \
     --url https://pluraluat.v2.pinepg.in/api/pay/v1/orders/order_id/capture \
     --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c ' \
     --header 'Content-Type: application/json' \
     --header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
     --header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
     --header 'accept: application/json' \
     --data '
{
  "merchant_capture_reference": "merchant-capture-ref-r4y",
  "capture_amount": {
    "value": 4000,
    "currency": "INR"
  }
}
'

    curl --request PUT \
     --url https://api.pluralpay.in/api/pay/v1/orders/order_id/capture \
     --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c ' \
     --header 'Content-Type: application/json' \
     --header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
     --header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
     --header 'accept: application/json' \
     --data '
{
  "merchant_capture_reference": "merchant-capture-ref-r4y",
  "capture_amount": {
    "value": 4000,
    "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,
    "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":"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"
          }
        },
        "acquirer_data":{
          "approval_code":"000000",
          "acquirer_reference":"202456643801053",
          "rrn":"420145000226"
        },
        "capture_data":[
          {
            "merchant_capture_reference":"f31d8c60-0dc8-4788-a577-5ced930cc175",
            "capture_amount":{
              "value":1100,
              "currency":"INR"
            },
            "created_at":"2024-07-19T11:13:21.523Z"
          }
        ],
        "created_at":"2024-07-19T11:11:48.944Z",
        "updated_at":"2024-07-19T11:13:23.962Z"
      }
    ],
    "created_at":"2024-07-19T11:11:48.944Z",
    "updated_at":"2024-07-19T11:13:23.962Z"
  }
}
    Click here for request and response parameter information.
    Request Parameters
    Response Parameters

    The table below lists the path parameter of our Capture Order API.

    Parameter Type Description
    order_id required string Unique identifier of the order in the Pine Labs Online database.

    Example: v1-5757575757-aa-hU1rUd

    The table below lists the request parameter of our Capture Order API.

    Parameter Type Description
    merchant_capture_reference required string Enter a unique identifier for the capture order request.
    • Maximum length: 50 characters.
    • Minimum length: 1 character.
    Example: 123456789

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • -
    • \
    • _
    capture_amount object Mandatory for a partial capture request.

    An object that contains the capture amount details.

    Learn more about our capture_amount child object.

    Capture Amount [Child Object]

    The table below lists the various parameters in the capture_amount child object. This object is part of the capture_order request object.

    Parameter Type Description
    value required integer The split amount in Paisa.
    • Minimum value: 100 (₹1).
    • Maximum value: 100000000 (₹10 lakh).
    Example: 100
    currency required string Type of currency.

    Example: 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 Pine Labs Online database.
    • Max length: 50 characters.
    Example: v1-5757575757-aa-hU1rUd
    merchant_order_reference string Unique identifier entered while creating an order.
    • Min length: 1 character.
    • Max 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
    • 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.
    merchant_id string Unique identifier of the merchant in the 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.
    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
    allowed_payment_methods array of strings The type of payment methods you want to offer customers.

    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 URL to redirect customers to success or failure pages.

    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 order request was received.

    Example: 2024-07-09T07:57:08.022Z
    updated_at string The ISO 8601 UTC Timestamp when the order object was updated.

    Example: 2024-07-09T07:57:08.022Z
    integration_mode string> Type of integration.

    Example: SEAMLESS
    payment_retries_remaining integer> Number of retry attempts left.

    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 create order request object.

    Parameter Type Description
    value integer Transaction amount in 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 create order request 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"

    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 Pine Labs Online database.
    • Minimum length: 1 character.
    • Maximum length: 19 characters.
    Example: 123456
    mobile_number string Customer's mobile number.
    • Minimum length: 9 characters.
    • Maximum length: 20 characters.
    Example: 9876543210
    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
    address1stringCustomer's billing address1.
    • Max length: 100 characters.
    Example: 10 Downing Street Westminster London
    address2stringCustomer's billing address2.
    • Max length: 100 characters.
    Example: Oxford Street Westminster London
    address3stringCustomer's billing address3.
    • Max length: 100 characters.
    Example: Baker Street Westminster London
    pincodestringPincode of the billing address.
    • Min length: 6 characters.
    • Max length: 10 characters.
    Example: 51524036
    citystringCity of the billing address.
    • Max length: 50 characters.
    Example: Westminster
    statestringState of the billing address.
    • Max length: 50 characters.
    Example: Westminster
    countrystringCountry of the billing address.
    • Max 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
    address1stringCustomer's shipping address1.
    • Max length: 100 characters.
    Example: 10 Downing Street Westminster London
    address2stringCustomer's shipping address2.
    • Max length: 100 characters.
    Example: Oxford Street Westminster London
    address3stringCustomer's shipping address3.
    • Max length: 100 characters.
    Example: Baker Street Westminster London
    pincodestringPincode of the shipping address.
    • Min length: 6 characters
    • Max length: 10 characters.
    Example: 51524036
    citystringCity of the shipping address.
    • Max length: 50 characters.
    Example: Westminster
    statestringState of the shipping address.
    • Max length: 50 characters.
    Example: Westminster
    countrystringCountry of the shipping address.
    • Max 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.
    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 issuer's 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.

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

    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.

    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 was 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 in Paisa.
    • Minimum value: 100 (₹1).
    • Maximum value: 100000000 (₹10 lakh).
    Example: 100
    currency string Type of currency.

    Example: INR

    Refer to our Capture Order API documentation to learn more.

    7. Cancel Order

    Use this API to cancel the payment against an order.

    Use the below endpoint to cancel the payment against the order.

    PuT: https://pluraluat.v2.pinepg.in/api/pay/v1/orders/{order_id}/cancel

    PUT: https://api.pluralpay.in/api/pay/v1/orders/{order_id}/cancel

    Shown below is a sample response for a Cancel Order API.

    {
  "data":{
    "order_id":"v1-5757575757-aa-hU1rUd",
    "merchant_order_reference":"2177120b-3be1-4330-a15f-53ce14d19841",
    "type":"CHARGE",
    "status":"CANCELLED",
    "merchant_id":"123456",
    "order_amount":{
      "value":50000,
      "currency":"INR"
    },
    "pre_auth":true,
    "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":"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":"",
          "address3":"",
          "pincode":"144001123",
          "city":"CHANDIGARH",
          "state":"PUNJAB",
          "country":"INDIA"
        }
      },
      "merchant_metadata":{
        "key1":"DD",
        "key2":"XOF"
      }
    },
    "payments":[
      {
        "id":"v1-2711071924-aa-VxIzq1-cc-Z",
        "status":"CANCELLED",
        "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"
          }
        },
        "acquirer_data":{
          "approval_code":"000000",
          "acquirer_reference":"202456644249243",
          "rrn":"420123000239"
        },
        "created_at":"2024-07-19T11:27:55.664Z",
        "updated_at":"2024-07-19T11:28:52.487Z"
      }
    ],
    "created_at":"2024-07-19T11:27:55.664Z",
    "updated_at":"2024-07-19T11:28:52.487Z"
  }
}
    Click here for request and response parameter information.
    Request Parameters
    Response Parameters

    The table below lists the path parameter of our Capture Order API.

    Parameter Type Description
    order_id required string Unique identifier of the order in the Pine Labs Online database.

    Example: v1-5757575757-aa-hU1rUd

    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 Pine Labs Online database.
    • Max length: 50 characters.
    Example: v1-5757575757-aa-hU1rUd
    merchant_order_reference string Unique identifier entered while creating an order.
    • Min length: 1 character.
    • Max 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
    • 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.
    merchant_id string Unique identifier of the merchant in the 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.
    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
    callback_url string URL to redirect customers to success or failure pages.

    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 order request was received.

    Example: 2024-07-09T07:57:08.022Z
    updated_at string The ISO 8601 UTC Timestamp when the order object was updated.

    Example: 2024-07-09T07:57:08.022Z
    integration_mode string> Type of integration.

    Example: SEAMLESS
    payment_retries_remaining integer> Number of retry attempts left.

    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 create order request object.

    Parameter Type Description
    value integer Transaction amount in 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 create order request 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"

    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 Pine Labs Online database.
    • Minimum length: 1 character.
    • Maximum length: 19 characters.
    Example: 123456
    mobile_number string Customer's mobile number.
    • Minimum length: 9 characters.
    • Maximum length: 20 characters.
    Example: 9876543210
    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
    address1stringCustomer's billing address1.
    • Max length: 100 characters.
    Example: 10 Downing Street Westminster London
    address2stringCustomer's billing address2.
    • Max length: 100 characters.
    Example: Oxford Street Westminster London
    address3stringCustomer's billing address3.
    • Max length: 100 characters.
    Example: Baker Street Westminster London
    pincodestringPincode of the billing address.
    • Min length: 6 characters.
    • Max length: 10 characters.
    Example: 51524036
    citystringCity of the billing address.
    • Max length: 50 characters.
    Example: Westminster
    statestringState of the billing address.
    • Max length: 50 characters.
    Example: Westminster
    countrystringCountry of the billing address.
    • Max 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
    address1stringCustomer's shipping address1.
    • Max length: 100 characters.
    Example: 10 Downing Street Westminster London
    address2stringCustomer's shipping address2.
    • Max length: 100 characters.
    Example: Oxford Street Westminster London
    address3stringCustomer's shipping address3.
    • Max length: 100 characters.
    Example: Baker Street Westminster London
    pincodestringPincode of the shipping address.
    • Min length: 6 characters
    • Max length: 10 characters.
    Example: 51524036
    citystringCity of the shipping address.
    • Max length: 50 characters.
    Example: Westminster
    statestringState of the shipping address.
    • Max length: 50 characters.
    Example: Westminster
    countrystringCountry of the shipping address.
    • Max 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.
    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 issuer's 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.

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

    Refer to our Cancel Order API documentation to learn more.

    Updated 23 days ago

    Ask AI
    Assistant
    Hourly Limit
    0 / 20000 tokens used Resets in: 60m 0s
    Order Lifecycle
    Refunds
    Settlements
    Checkout
    Dashboard
    International Payments
    How do I implement webhook notifications for payment status updates, and what's the recommended way to verify webhook authenticity?
    How do I integrate Pine Labs payment gateway with my React Native mobile app and what are the required API credentials?
    Can I customize the payment UI for card transactions, and what parameters can I pass to modify the checkout experience for my customers?
    Assistant