Payment Link Object – Pine Labs API

Shown below is a sample response returned through our Create Payment Link API.

{
  "payment_link": "https://shortener.v2.pinepg.in/PLUTUS/3rh4jtd",
  "payment_link_id": "pl-v1-250306082755-aa-uT0noy",
  "status": "CREATED",
  "amount": {
    "value": 100,
    "currency": "INR"
  },
  "amount_due": {
    "value": 100,
    "currency": "INR"
  },
  "order_id": "v1-250131113650-aa-TUzeRY",
  "merchant_payment_link_reference": "link_ref",
  "description": "Payment for order #12345",
  "expire_by": "2025-03-21T08:29Z",
  "allowed_payment_methods": [
    "NETBANKING"
  ],
  "pre_auth": false,
  "failure_callback_url": null,
  "is_mcc_transaction": true,
  "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"
    }
  },
  "product_details": [
    {
      "product_code": "xyz",
      "product_amount": {
        "currency": "INR",
        "value": 1200000
      },
      "product_coupon_discount_amount": {
        "currency": "INR",
        "value": 0
      }
    }
  ],
  "split_info": {
    "split_type": "AMOUNT",
    "split_details": [
      {
        "split_merchant_id": "111302",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "on_hold": true
      },
      {
        "split_merchant_id": "111302",
        "amount": {
          "value": 100,
          "currency": "INR"
        },
        "on_hold": true
      }
    ]
  },
  "cart_coupon_discount_amount": {
    "currency": "INR",
    "value": 0
  },
  "merchant_metadata": {
    "Key_XY": "DD",
    "Key_ZZ": "XOY"
  },
  "created_at": "2025-03-06T08:27:55.881Z",
  "updated_at": "2025-03-06T08:27:55.881Z"
}

The table below lists the various parameters returned in our Create Payment Link API response object.

Parameter	Type	Description
payment_link	`string`	Payment link. Example: `https://shortener.v2.pinepg.in/PLUTUS/3rh4jtd`
payment_link_id	`string`	Unique identifier of the order in the Pine Labs Online database. Maximum length: `50` characters. Example: `pl-v1-250306082755-aa-uT0noy`
status	`string`	Payment link status. Possible values: `CREATED`: When the create payment link request is successfully received by Pine Labs Online. The payment link has been created and shared with the customer. `CLICKED`: The customer has clicked on the payment link to initiate a payment. `PAYMENT_INITIATED`: The customer has successfully accessed the payment link and completed the payment. We have submitted the payment request to the bank, waiting for the bank's confirmation. `PROCESSED`: The payment is successfully processed. Here the money is debited from your customer account and credited to your account. `PARTIAL_PROCESSED`: The partial payment is successfully processed. Here the money is debited from your customer account and credited to your account. `EXPIRED`: The payment link has expired. `CANCELLED`: The payment link is canelled.
amount	`object`	An object that contains the payment amount details. Learn more about the `amount` child object.
amount_due	`object`	An object that contains the payment amount due details. Learn more about the `amount_due` child object.
order_id	`string`	Unique identifier of the order in the Pine Labs Online database. Example: `v1-250131113650-aa-TUzeRY`
merchant_payment_link_reference	`string`	Unique identifier entered while creating a payment link. Minimum length: `1` character. Maximum length: `50` characters. Example: `link_ref`
description	`string`	Corresponding message against the payment link. Example: `Order Payment Link`
expire_by	`string`	Timestamp when the payment link get expired. Example: `2024-04-30T08:01:32Z`
allowed_payment_methods	`array of strings`	The type of payment methods you want to offer your customers to accept payments. Accepted values: `CARD` `UPI` `POINTS` `NETBANKING` `WALLET` `CREDIT_EMI` `DEBIT_EMI` Example: CARD Note: Before selecting a payment method, ensure it is configured for you.
pre_auth	`boolean`	The pre-authorization type. Possible values: `true`: When pre-authorization is needed. `false` (default): When pre-authorization is not required. Example: `false` Learn more about our pre authorization.
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.
is_mcc_transaction	`boolean`	Identifies the Payment Link type. Possible values: `true`: The payment link is processed for a MCC transaction. `false` (default): The payment link is processed for a regular transaction. Note: It is Mandatory to set this parameter to `true` for MCC transactions to ensure smooth payment link processing and avoid failures.
customer	`object`	An object that contains the customer information details. Learn more about the `customer` child object.
product_details	`array of objects`	An array of objects, that contains the list of products associated with the payment details. Learn more about the `product_details` child object.
split_info	`object`	An object that contains the split information details. Learn more about the `split_info` child object.
account_details	`object`	An object that contains the account details. Learn more about the `account_details` child object.
cart_coupon_discount_amount	`object`	An object that contains the cart coupon discount details. Learn more about the `cart_coupon_discount_amount` child object.
merchant_metadata	`object`	An object of key-value pair that can be used to store additional information. Example: `"key1": "DD"`
created_at	`string`	The ISO 8601 UTC Timestamp, when the create payment link request was received by Pine Labs Online. Example: `2024-07-09T07:57:08.022Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the create payment link response object is updated. Example: `2024-07-09T07:57:08.022Z`

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the Create Payment Link API response object.

Parameter	Type	Description
currency	`String`	Type of currency. Example: INR
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`

Amount Due [Child Object]

The table below lists the various parameters in the amount_due child object. This object is part of the Create Payment Link API response object.

Parameter	Type	Description
currency	`String`	Type of currency. Example: INR
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`

Customer [Child Object]

The table below lists the various parameters in the customer child object. This object is part of the Create Payment Link API response 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: `10` character. Maximum length: `20` characters. Example: `9876543210` Supported characters: `0-9`
country_code	`string`	Country code of the mobile number. Example: `91`
billing_address	`object`	An object that contains the details of the billing address. Learn more about the `billing_address` child object.
shipping_address	`object`	An object that contains the shipping address details. Learn more about the `shipping_address` child object.
merchant_customer_reference	`string`	Unique identifier of the customer for the request. Minimum length: `1` character. Maximum length: `50` characters. Example: `customer_reference`
gstin	`string`	Customers GSTIN. Example: `27AAEPM1234C1Z5`

Billing Address [Child Object]

The table below lists the various parameters in the billing_address child object. This is part of the customer object.

Parameter	Type	Description
address1	`string`	Customer's billing address1. Maximum length: 100 characters. Example: `10 Downing Street Westminster London`
address2	`string`	Customer's billing address2. Maximum length: 100 characters. Example: `Oxford Street Westminster London`
address3	`string`	Customer's billing address3. Maximum length: 100 characters. Example: `Baker Street Westminster London`
pincode	`string`	Pincode of the billing address. Minimum length: 6 characters. Maximum length: 10 characters. Example: `51524036` Supported characters: `0-9`
city	`string`	City of the billing address. Maximum length: 50 characters. Example: `Westminster`
state	`string`	State of the billing address. Maximum length: 50 characters. Example: `Westminster`
country	`string`	Country of the billing address. Maximum length: 50 characters. Example: `London`

Shipping Address [Child Object]

The table below lists the various parameters in the shipping_address child object. This is part of the customer object.

Parameter	Type	Description
address1	`string`	Customer's shipping address1. Maximum length: 100 characters. Example: `10 Downing Street Westminster London`
address2	`string`	Customer's shipping address2. Maximum length: 100 characters. Example: `Oxford Street Westminster London`
address3	`string`	Customer's shipping address3. Maximum length: 100 characters. Example: `Baker Street Westminster London`
pincode	`string`	Pincode of the shipping address. Minimum length: 6 characters. Maximum length: 10 characters. Example: `51524036` Supported characters: `0-9`
city	`string`	City of the shipping address. Maximum length: 50 characters. Example: `Westminster`
state	`string`	State of the shipping address. Maximum length: 50 characters. Example: `Westminster`
country	`string`	Country of the shipping address. Maximum length: 50 characters. Example: `London`

Product Details [Child Object]

The table below lists the various parameters in the product_details child object. This object is part of the Create Payment Link API response object.

Parameter	Type	Description
product_code	`string`	Unique Product identifier of the product. Example: `redmi_10`
product_amount	`object`	An object that contains the product amount details. Learn more about the `product_amount` child object.
product_coupon_discount_amount	`object`	An object that contains the product coupon discount amount details. Learn more about the `product_coupon_discount_amount` child object.

Product Amount [Child Object]

The table below lists the various parameters in the product_amount child object. This object is part of the product_details response object.

Parameter	Type	Description
currency	`String`	Type of currency. Example: INR
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`

Product Coupon Discount Amount [Child Object]

The table below lists the various parameters in the product_coupon_discount_amount child object. This object is part of the product_details response object.

Parameter	Type	Description
currency	`String`	Type of currency. Example: INR
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`

Split Info [Child Object]

The table below lists the various parameters in the split_info child object. This is part of the payment link response object.

Parameter	Type	Description
split_type	`string`	Type of split. Example: `Amount`
split_details	`array of objects`	An array of objects that contains the split details. Learn more about the `split_details` child object.

Split Details [Child Object]

The table below lists the various parameters in the split_details child object. This is part of the split_info object.

Parameter	Type	Description
split_merchant_id	`string`	Unique identifier of your partner merchant in the Pine Labs Online database. Example: `123456`
merchant_settlement_reference	`string`	Unique identifier entered while creating a order in split. Maximum length: 50 characters. Example: `5206071124-aa-mpLhF3-cc-l`
split_settlement_id	`string`	Unique identifier of the split settlement in the Pine Labs Online database. Maximum length: 50 characters. Example: `71124-aa-mpLhF3-cc-l` Note: Use this Settlement ID to initiate a release a settlement using our Release Settlement API.
amount	`object`	An object that contains the split amount details. Learn more about the `amount` child object.
on_hold	`boolean`	Indicate whether the settlement is on hold for future release. Accepted values: `true`: The settlement is placed on hold. `false`: The settlement is processed immediately.
status	`string`	Split Settlement status. Possible values: `RELEASED` `HOLD`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the split order was created by Pine Labs Online. Example: `2024-07-09T07:57:08.022Z`

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the split_details object.

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

Account Details [Child Object]

The table below lists the various parameters in the account_details child object. This is part of the payment link response object.

Parameter	Type	Description
bank_details	`object`	An object that contains the bank details. Learn more about the `bank_details` child object.

Bank Details [Child Object]

The table below lists the various parameters in the bank_details child object. This is part of the account_details object.

Parameter	Type	Description
account_number	`string`	Customer's bank account number. Example: `500000004545`
ifsc_code	`string`	Customer's bank IFSC. Example: `BANK0000123`
bank_name	`string`	Customer's account holding bank name. Example: `Example Bank`

Cart Coupon Discount Amount [Child Object]

The table below lists the various parameters in the cart_coupon_discount_amount child object. This object is part of the Create Payment Link API response object.

Parameter	Type	Description
currency	`String`	Type of currency. Example: INR
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`