Object

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.

ParameterTypeDescription
payment_linkstringPayment link.

Example: https://shortener.v2.pinepg.in/PLUTUS/3rh4jtd
payment_link_idstringUnique identifier of the order in the Plural database.
  • Maximum length: 50 characters.
Example: pl-v1-250306082755-aa-uT0noy
statusstringPayment link status.

Possible values:
  • CREATED: When the create payment link request is successfully received by Plural. 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.
amountobjectAn object that contains the payment amount details.

Learn more about the amount child object.
amount_dueobjectAn object that contains the payment amount due details.

Learn more about the amount_due child object.
order_idstringUnique identifier of the order in the Plural database.

Example: v1-250131113650-aa-TUzeRY
merchant_payment_link_referencestringUnique identifier entered while creating a payment link.
  • Minimum length: 1 character.
  • Maximum length: 50 characters.
Example: link_ref
descriptionstringCorresponding message against the payment link.

Example: Order Payment Link
expire_bystringTimestamp when the payment link get expired.

Example: 2024-04-30T08:01:32Z
allowed_payment_methodsarray of stringsThe 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.
customerobjectAn object that contains the customer information details.

Learn more about the customer child object.
product_detailsarray of objectsAn 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_amountobjectAn object that contains the cart coupon discount details.

Learn more about the cart_coupon_discount_amount child object.
merchant_metadataobjectAn object of key-value pair that can be used to store additional information.

Example: "key1": "DD"
created_atstringThe ISO 8601 UTC Timestamp, when the create payment link request was received by Plural.

Example: 2024-07-09T07:57:08.022Z
updated_atstringThe 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.

ParameterTypeDescription
currencyStringType of currency.

Example: INR
valueintegerTransaction 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.

ParameterTypeDescription
currencyStringType of currency.

Example: INR
valueintegerTransaction 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.

ParameterTypeDescription
email_idstringCustomer's email address.
  • Minimum length: 1 character.
  • Maximum length: 50 characters.
Example: [email protected]
first_namestringCustomer's first name.
  • Minimum length: 1 character.
  • Maximum length: 50 characters.
Example: Kevin
last_namestringCustomer's last name.
  • Minimum length: 1 character.
  • Maximum length: 50 characters.
Example: Bob
customer_idstringUnique identifier of the customer in the Plural database.
  • Minimum length: 1 character.
  • Maximum length: 19 characters.
Example: 123456
mobile_numberstringCustomer's mobile number.
  • Minimum length: 10 character.
  • Maximum length: 20 characters.
Example: 9876543210

Supported characters:
  • 0-9
country_codestringCountry code of the mobile number.

Example: 91
billing_addressobjectAn object that contains the details of the billing address.

Learn more about the billing_address child object.
shipping_addressobjectAn object that contains the shipping address details.

Learn more about the shipping_address child object.
merchant_customer_referencestringUnique identifier of the customer for the request.
  • Minimum length: 1 character.
  • Maximum length: 50 characters.
Example: customer_reference
gstinstringCustomers 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.

ParameterTypeDescription
address1stringCustomer's billing address1.
  • Maximum length: 100 characters.
Example: 10 Downing Street Westminster London
address2stringCustomer's billing address2.
  • Maximum length: 100 characters.
Example: Oxford Street Westminster London
address3stringCustomer's billing address3.
  • Maximum length: 100 characters.
Example: Baker Street Westminster London
pincodestringPincode of the billing address.
  • Minimum length: 6 characters.
  • Maximum length: 10 characters.
Example: 51524036

Supported characters:
  • 0-9
citystringCity of the billing address.
  • Maximum length: 50 characters.
Example: Westminster
statestringState of the billing address.
  • Maximum length: 50 characters.
Example: Westminster
countrystringCountry 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.

ParameterTypeDescription
address1stringCustomer's shipping address1.
  • Maximum length: 100 characters.
Example: 10 Downing Street Westminster London
address2stringCustomer's shipping address2.
  • Maximum length: 100 characters.
Example: Oxford Street Westminster London
address3stringCustomer's shipping address3.
  • Maximum length: 100 characters.
Example: Baker Street Westminster London
pincodestringPincode of the shipping address.
  • Minimum length: 6 characters.
  • Maximum length: 10 characters.
Example: 51524036

Supported characters:
  • 0-9
citystringCity of the shipping address.
  • Maximum length: 50 characters.
Example: Westminster
statestringState of the shipping address.
  • Maximum length: 50 characters.
Example: Westminster
countrystringCountry 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.

ParameterTypeDescription
product_codestringUnique Product identifier of the product.

Example: redmi_10
product_amountobjectAn object that contains the product amount details.

Learn more about the product_amount child object.
product_coupon_discount_amountobjectAn 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.

ParameterTypeDescription
currencyStringType of currency.

Example: INR
valueintegerTransaction 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.

ParameterTypeDescription
currencyStringType of currency.

Example: INR
valueintegerTransaction amount is Paisa.
  • Minimum value: 100 (₹1)
  • Maximum value: 100000000 (₹10 lakh).
Example: 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.

ParameterTypeDescription
currencyStringType of currency.

Example: INR
valueintegerTransaction amount is Paisa.
  • Minimum value: 100 (₹1)
  • Maximum value: 100000000 (₹10 lakh).
Example: 1000