# Create Payment Link Use this API to create a Payment Link. ## Environment Use our UAT environment endpoint for testing and for integration utilize our production endpoint. | Environment | Endpoints | | :----------------------------- | :------------------------------------------------------ | | User Acceptance Testing \[UAT] | `https://pluraluat.v2.pinepg.in/api/pay/v1/paymentlink` | | Production \[PROD] | `https://api.pluralpay.in/api/pay/v1/paymentlink` | > 📘 Note: > > * Ensure that your **Merchant ID** is configured for `Pay by Link`, `split payments`, and `pre-authorization` before creating a payment link. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "order", "version": "3.0" }, "servers": [ { "url": "https://pluraluat.v2.pinepg.in/api" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "Authorization", "in": "header", "x-bearer-format": "bearer", "x-default": "" } } }, "security": [ { "sec0": [] } ], "paths": { "/pay/v1/paymentlink": { "post": { "summary": "Create Payment Link", "description": "Use this API to create a Payment Link.", "operationId": "payment-link-create", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The type of content included in the HTTP message body.

Possible value: `application/json`.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "The HTTP header where you can include your secret token for authentication.

Example: `Bearer `

**Note**: Use the access token generated using our Generate Token API.", "required": true, "schema": { "type": "string", "default": "Bearer" } }, { "name": "Request-Timestamp", "in": "header", "description": "Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.

Example: `2024-07-09T07:57:08.022Z`", "schema": { "type": "string" } }, { "name": "Request-ID", "in": "header", "description": "Use a global unique identifier [GUID] for the request.Example: `c17ce30f-f88e-4f81-ada1-c3b4909ed235`", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "merchant_payment_link_reference" ], "properties": { "amount": { "type": "object", "description": "An object that contains the payment amount details.", "required": [ "value", "currency" ], "properties": { "value": { "type": "integer", "description": "The transaction amount in Paisa.
Example: `1100`", "format": "int32" }, "currency": { "type": "string", "description": "Type of currency.

Example: `INR`" } } }, "description": { "type": "string", "description": "Enter the description corresponding to the payment.

Example: `Payment for Order1`" }, "expire_by": { "type": "string", "description": "The desired expiration timestamp for the payment link.

Example: `2024-10-28T13:26:06.909140Z`

**Note**:" }, "allowed_payment_methods": { "type": "string", "description": "The type of payment methods you want to offer your customers to accept payments.

Accepted values:Example: `CARD`

**Note**: Before selecting a payment method, ensure it is configured for you." }, "pre_auth": { "type": "string", "description": "The pre-authorization type.

Possible values:" }, "is_mcc_transaction": { "type": "string", "description": "Identifies the Payment Link type.

Possible values:**Note**: It is Mandatory to set this parameter to `true` for **MCC** transactions to ensure smooth payment link processing and avoid failures." }, "failure_callback_url": { "type": "string", "description": "The URL specifically used to redirect customers to a failure page based on the payment link or product details.

**Note**:" }, "merchant_payment_link_reference": { "type": "string", "description": "Enter a unique identifier for the payment link request.Example: `1234567890`

Supported characters:" }, "customer": { "type": "object", "description": "An object that contains the customer information details.", "properties": { "merchant_customer_reference": { "type": "string", "description": "Unique reference for the customer in your system.Example: `1234567890`

Supported characters:" }, "email_id": { "type": "string", "description": "Customer's email address.
Example: `kevin.bob@example.com`

Supported characters:" }, "first_name": { "type": "string", "description": "Customer's first name.
Example: `Kevin`

Supported characters:" }, "last_name": { "type": "string", "description": "Customer's last name.
Example: `Bob`

Supported characters:" }, "customer_id": { "type": "string", "description": "Unique identifier of the customer in the Pine Labs Online database.
Example: `123456`" }, "mobile_number": { "type": "string", "description": "Customer's mobile number.
Example: `9876543210`

Supported characters:" }, "country_code": { "type": "string", "description": "Country code of the registered mobile number.Example: `+91`

**Note**: If the country code is not provided, it defaults to `+91`." }, "billing_address": { "type": "string", "description": "An object that contains the details of the billing address." }, "shipping_address": { "type": "string", "description": "An object that contains the shipping address details." }, "gstin": { "type": "string", "description": "Customer's Goods and Services Tax Identification Number (GSTIN).

Has to be `15` digits.

Example: `29ABCDE1234F1Z5`" } } }, "product_details": { "type": "array", "description": "An array of objects, that contains the list of products associated with the payment details.", "items": { "properties": { "product_code": { "type": "string", "description": "Unique Product identifier of the product.

Example: `redmi_10`" }, "product_amount": { "type": "object", "description": "An object that contains the product amount details.", "required": [ "value", "currency" ], "properties": { "value": { "type": "integer", "description": "The transaction amount in Paisa.
Example: `1100`", "format": "int32" }, "currency": { "type": "string", "description": "Type of currency.

Example: `INR`" } } }, "product_coupon_discount_amount": { "type": "object", "description": "An object that contains the product coupon discount amount details.", "required": [ "value", "currency" ], "properties": { "value": { "type": "integer", "description": "The transaction amount in Paisa.
Example: `1100`", "format": "int32" }, "currency": { "type": "string", "description": "Type of currency.

Example: `INR`" } } } }, "required": [ "product_code" ], "type": "object" } }, "cart_coupon_discount_amount": { "type": "object", "description": "An object that contains the cart coupon discount details.", "required": [ "value", "currency" ], "properties": { "value": { "type": "integer", "description": "The transaction amount in Paisa.
Example: `1100`", "format": "int32" }, "currency": { "type": "string", "description": "Type of currency.

Example: `INR`" } } }, "merchant_metadata": { "type": "object", "description": "An object that contains the user defined informations.", "properties": { "key1": { "type": "string" }, "key2": { "type": "string" } } }, "split_info": { "type": "object", "description": "**Mandatory for Split Settlements**

An object that contains the split settlement information.

**Note**: Kindly ensure split settlements are enabled for your account in the Pine Labs Online database.", "required": [ "split_type" ], "properties": { "split_type": { "type": "string", "description": "Type of Split.

Example: `AMOUNT`

Accepted values: " }, "split_details": { "type": "array", "description": "**Mandatory object**

An array of split settlement details.", "items": { "properties": { "split_merchant_id": { "type": "string", "description": "Unique identifier of your partner merchant in the Pine Labs Online database.

Example: `123456`" }, "merchant_settlement_reference": { "type": "string", "description": "Unique identifier entered while creating a order in split.Example: `asdf-1234-qwer-5678`" }, "amount": { "type": "string", "description": "**Mandatory when `split_type` is `AMOUNT`**

An object that contains the split amount details." }, "on_hold": { "type": "string", "description": "Indicate whether the settlement is on hold for future release.

Accepted values: " }, "split_percentage": { "type": "string", "description": "**Mandatory when `split_type` is `PERCENTAGE`**

Percentage of the total payment amount to be settled to the specified `split_merchant_id`.

Example: `45.23`" } }, "required": [ "split_merchant_id", "on_hold" ], "type": "object" } } } }, "account_details": { "type": "object", "description": "An object that contains the customers bank account details.", "properties": { "bank_details": { "type": "object", "description": "An object that contains the bank account details.", "required": [ "account_number" ], "properties": { "account_number": { "type": "string", "description": "Customer's bank account number.

Example: `500000004545`" }, "ifsc_code": { "type": "string", "description": "Customer's bank IFSC.

Example: `BANK0000123`" }, "bank_name": { "type": "string", "description": "Customer's account holding bank name.

Example: `Example Bank`" } } } } }, "callback_url": { "type": "string", "description": "The URL to which your customers are redirected based on the order or product details, leading them to either a success or failure page.

Example: `https://sample-callback-url`" }, "part_payment": { "type": "boolean", "description": "Indicates whether the order is for part payments or full.

Possible values:Example: `true`" }, "cart_details": { "type": "object", "description": "An object that contains cart details.

**Note**: If cart details are provided, cart information will be displayed during checkout.", "properties": { "cart_items": { "type": "array", "description": "An object that contains the cart item details.", "items": { "properties": { "item_id": { "type": "string", "description": "Unique identifier of the item.

Example: `cart_id_1`" }, "item_name": { "type": "string", "description": "Name of the item.

Example: `T Shirt`" }, "item_description": { "type": "string", "description": "Description corresponding to the item.

Example: `Shopping on Diwali Sale`" }, "item_details_url": { "type": "string", "description": "URL containing additional details about the item." }, "item_image_url": { "type": "string", "description": "Image URL of the item.

Example: `https://chriscross.in/cdn/shop/files/95_800x.jpg`

**Note**: To ensure better resolution and optimal display on the checkout, please provide the image in `24x24` dimensions." }, "item_original_unit_price": { "type": "string", "description": "Original price of the item.

Example: 199" }, "item_discounted_unit_price": { "type": "string", "description": "Discount price of the item.

Example: `149`" }, "item_quantity": { "type": "string", "description": "Number of items purchased.

Example: `2`" }, "item_currency": { "type": "string", "description": "Indicates the currency type for the purchase of the item.

Example: `INR`" }, "emi_product_code": { "type": "string", "description": "EMI product code associated with the item." } }, "type": "object" } } } } } }, "examples": { "Create Payment Link": { "value": { "amount": { "value": 1, "currency": "INR" }, "description": "Payment for order #12345", "callback_url": "https://sample-callback-url", "merchant_payment_link_reference": "f182698d-9915-4cf8-b9cf-9e31c342430c", "customer": { "email_id": "kevin.bob@example.com", "first_name": "Kevin", "last_name": "Bob", "customer_id": "123456", "mobile_number": "9164691123", "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": { "test1": "testValue1", "test2": "testValue2", "test3": "testValue3" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"payment_link\": \"https://shortener.v2.pinepg.in/PLUTUS/3rh4jtd\",\n \"payment_link_id\": \"pl-v1-250306082755-aa-uT0noy\",\n \"status\": \"CREATED\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"INR\"\n },\n \"amount_due\": {\n \"value\": 100,\n \"currency\": \"INR\"\n },\n \"order_id\": \"v1-250131113650-aa-TUzeRY\",\n \"merchant_payment_link_reference\": \"link_ref\",\n \"description\": \"Payment for order #12345\",\n \"expire_by\": \"2025-03-21T08:29Z\",\n \"allowed_payment_methods\": [\n \"NETBANKING\"\n ],\n \"pre_auth\": false,\n \"failure_callback_url\": null,\n \"is_mcc_transaction\": true,\n \"customer\": {\n \"email_id\": \"kevin.bob@example.com\",\n \"first_name\": \"Kevin\",\n \"last_name\": \"Bob\",\n \"customer_id\": \"123456\",\n \"mobile_number\": \"9876543210\",\n \"country_code\": \"91\",\n \"billing_address\": {\n \"address1\": \"10 Downing Street Westminster London\",\n \"address2\": \"Oxford Street Westminster London\",\n \"address3\": \"Baker Street Westminster London\",\n \"pincode\": \"51524036\",\n \"city\": \"Westminster\",\n \"state\": \"Westminster\",\n \"country\": \"London\"\n },\n \"shipping_address\": {\n \"address1\": \"10 Downing Street Westminster London\",\n \"address2\": \"Oxford Street Westminster London\",\n \"address3\": \"Baker Street Westminster London\",\n \"pincode\": \"51524036\",\n \"city\": \"Westminster\",\n \"state\": \"Westminster\",\n \"country\": \"London\"\n }\n },\n \"product_details\": [\n {\n \"product_code\": \"xyz\",\n \"product_amount\": {\n \"currency\": \"INR\",\n \"value\": 1200000\n },\n \"product_coupon_discount_amount\": {\n \"currency\": \"INR\",\n \"value\": 0\n }\n }\n ],\n \"split_info\": {\n \"split_type\": \"AMOUNT\",\n \"split_details\": [\n {\n \"split_merchant_id\": \"111302\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"INR\"\n },\n \"on_hold\": true\n },\n {\n \"split_merchant_id\": \"111302\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"INR\"\n },\n \"on_hold\": true\n }\n ]\n },\n \"cart_coupon_discount_amount\": {\n \"currency\": \"INR\",\n \"value\": 0\n },\n \"merchant_metadata\": {\n \"Key_XY\": \"DD\",\n \"Key_ZZ\": \"XOY\"\n },\n \"created_at\": \"2025-03-06T08:27:55.881Z\",\n \"updated_at\": \"2025-03-06T08:27:55.881Z\"\n}" } }, "schema": { "type": "object", "properties": { "payment_link": { "type": "string", "example": "https://shortener.v2.pinepg.in/PLUTUS/3rh4jtd" }, "payment_link_id": { "type": "string", "example": "pl-v1-250306082755-aa-uT0noy" }, "status": { "type": "string", "example": "CREATED" }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 100, "default": 0 }, "currency": { "type": "string", "example": "INR" } } }, "amount_due": { "type": "object", "properties": { "value": { "type": "integer", "example": 100, "default": 0 }, "currency": { "type": "string", "example": "INR" } } }, "order_id": { "type": "string", "example": "v1-250131113650-aa-TUzeRY" }, "merchant_payment_link_reference": { "type": "string", "example": "link_ref" }, "description": { "type": "string", "example": "Payment for order #12345" }, "expire_by": { "type": "string", "example": "2025-03-21T08:29Z" }, "allowed_payment_methods": { "type": "array", "items": { "type": "string", "example": "NETBANKING" } }, "pre_auth": { "type": "boolean", "example": false, "default": true }, "failure_callback_url": {}, "is_mcc_transaction": { "type": "boolean", "example": true, "default": true }, "customer": { "type": "object", "properties": { "email_id": { "type": "string", "example": "kevin.bob@example.com" }, "first_name": { "type": "string", "example": "Kevin" }, "last_name": { "type": "string", "example": "Bob" }, "customer_id": { "type": "string", "example": "123456" }, "mobile_number": { "type": "string", "example": "9876543210" }, "country_code": { "type": "string", "example": "91" }, "billing_address": { "type": "object", "properties": { "address1": { "type": "string", "example": "10 Downing Street Westminster London" }, "address2": { "type": "string", "example": "Oxford Street Westminster London" }, "address3": { "type": "string", "example": "Baker Street Westminster London" }, "pincode": { "type": "string", "example": "51524036" }, "city": { "type": "string", "example": "Westminster" }, "state": { "type": "string", "example": "Westminster" }, "country": { "type": "string", "example": "London" } } }, "shipping_address": { "type": "object", "properties": { "address1": { "type": "string", "example": "10 Downing Street Westminster London" }, "address2": { "type": "string", "example": "Oxford Street Westminster London" }, "address3": { "type": "string", "example": "Baker Street Westminster London" }, "pincode": { "type": "string", "example": "51524036" }, "city": { "type": "string", "example": "Westminster" }, "state": { "type": "string", "example": "Westminster" }, "country": { "type": "string", "example": "London" } } } } }, "product_details": { "type": "array", "items": { "type": "object", "properties": { "product_code": { "type": "string", "example": "xyz" }, "product_amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "INR" }, "value": { "type": "integer", "example": 1200000, "default": 0 } } }, "product_coupon_discount_amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "INR" }, "value": { "type": "integer", "example": 0, "default": 0 } } } } } }, "split_info": { "type": "object", "properties": { "split_type": { "type": "string", "example": "AMOUNT" }, "split_details": { "type": "array", "items": { "type": "object", "properties": { "split_merchant_id": { "type": "string", "example": "111302" }, "amount": { "type": "object", "properties": { "value": { "type": "integer", "example": 100, "default": 0 }, "currency": { "type": "string", "example": "INR" } } }, "on_hold": { "type": "boolean", "example": true, "default": true } } } } } }, "cart_coupon_discount_amount": { "type": "object", "properties": { "currency": { "type": "string", "example": "INR" }, "value": { "type": "integer", "example": 0, "default": 0 } } }, "merchant_metadata": { "type": "object", "properties": { "Key_XY": { "type": "string", "example": "DD" }, "Key_ZZ": { "type": "string", "example": "XOY" } } }, "created_at": { "type": "string", "example": "2025-03-06T08:27:55.881Z" }, "updated_at": { "type": "string", "example": "2025-03-06T08:27:55.881Z" } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"code\":\"INTERNAL_ERROR\",\n \"message\":\"failed to process because...\",\n \"additionalErrorPayload\":{\n \"source\":\"OMS\",\n \"step\":\"PAYMENT_CREATION\"\n }\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "INTERNAL_ERROR" }, "message": { "type": "string", "example": "failed to process because..." }, "additionalErrorPayload": { "type": "object", "properties": { "source": { "type": "string", "example": "OMS" }, "step": { "type": "string", "example": "PAYMENT_CREATION" } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```