Overview of the Pay by Link APIs response.
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"
],
"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
}
}
],
"cart_coupon_discount_amount": {
"currency": "INR",
"value": 0
},
"merchant_metadata": {
"clientId": "DD",
"transactionReferenceNo": "pine-1223",
"merchantId": "1234",
"tid": "9000990",
"acquirerName": "HDFC_FSS",
"isOfferDisplayRequired": "true",
"OfferData": "UHJvZHVjdF9Db2RlPSIgIiZQcm9kdWN0X05hbWU9IiImUGF5bWVudF9Nb2RlPUJhbmsgRU1JJkNhcmRfVHlwZT1EZWJpdCBDYXJkJkJhbmtfTmFtZT1IREZDIERlYml0JkVNSV9UZW51cmU9NiZJbnRlcmVzdF9SYXRlPTkuMCZJbnRlcmVzdF9BbW91bnQ9MTM4MTQwJk1vbnRobHlfSW5zdGFsbWVudD04OTQ2OTAmQXV0aG9yaXphdGlvbl9BbW91bnQ9MTAwJkxvYW5fYm9va2luZ19BbW91bnQ9NTIzMDAwMCZJbnRlcmVzdF9DYXNoYmFja19BbW91bnQ9MCZJbnRlcmVzdF9DYXNoYmFja19UeXBlPURlZmVycmVkJkFkZGl0aW9uYWxfQ2FzaGJhY2s9IiImQWRkaXRpb25hbF9DYXNoYmFja19UeXBlPSIiJkRlc2NyaXB0aW9uPUJhbmsgRU1JJlByb2R1Y3RfVmFsdWU9NTIzMDAwMA",
"tenant_id": "PGATPOS",
"is_offer_validation_required": "true"
},
"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 Plural database.
pl-v1-250306082755-aa-uT0noy |
status | string | Payment link status. Possible values:
|
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 Plural database. Example: v1-250131113650-aa-TUzeRY |
merchant_payment_link_reference | string | Unique identifier entered while creating a payment link.
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:
Note: Before selecting a payment method, ensure it is configured for you. |
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. |
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 Plural. 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.
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.
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.
[email protected] |
first_name | string | Customer's first name.
Kevin |
last_name | string | Customer's last name.
Bob |
customer_id | string | Unique identifier of the customer in the Plural database.
123456 |
mobile_number | string | Customer's mobile number.
9876543210 Supported characters:
|
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.
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.
10 Downing Street Westminster London |
address2 | string | Customer's billing address2.
Oxford Street Westminster London |
address3 | string | Customer's billing address3.
Baker Street Westminster London |
pincode | string | Pincode of the billing address.
51524036 Supported characters:
|
city | string | City of the billing address.
Westminster |
state | string | State of the billing address.
Westminster |
country | string | Country of the billing address.
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.
10 Downing Street Westminster London |
address2 | string | Customer's shipping address2.
Oxford Street Westminster London |
address3 | string | Customer's shipping address3.
Baker Street Westminster London |
pincode | string | Pincode of the shipping address.
51524036 Supported characters:
|
city | string | City of the shipping address.
Westminster |
state | string | State of the shipping address.
Westminster |
country | string | Country of the shipping address.
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.
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.
1000 |
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.
1000 |