Create Payment Link

post

https://pluraluat.v2.pinepg.in/api/pay/v1/paymentlink

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.

Body Params

amount

object

required

An object that contains the payment amount details.

description

string

Enter the description corresponding to the payment.

Example: Payment for Order1

expire_by

string

The desired expiration timestamp for the payment link.

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

Note:

The expiry timestamp must be set within a maximum of 180 days from the current date.
Once the payment link exceeds the expiration timestamp, it becomes invalid.

allowed_payment_methods

string

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

string

The pre-authorization type.

Possible values:

false (default): When pre-authorization is not required.
true: When pre-authorization is needed.

is_mcc_transaction

string

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.

failure_callback_url

string

The URL specifically used to redirect customers to a failure page based on the payment link or product details.

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.

merchant_payment_link_reference

string

required

Enter a unique identifier for the payment link request.

Minimum: 1 characters.
Maximum: 50 characters.

Example: 1234567890

Supported characters:

A-Z
a-z
-
_

customer

object

An object that contains the customer information details.

product_details

array of objects

An array of objects, that contains the list of products associated with the payment details.

product_details

cart_coupon_discount_amount

object

An object that contains the cart coupon discount details.

merchant_metadata

object

An object that contains the user defined informations.

split_info

object

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.

account_details

object

An object that contains the customers bank account details.

callback_url

string

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

boolean

Indicates whether the order is for part payments or full.

Possible values:

true: The order created is for a part payment.
false: The order is created for a full payment.

Example: true

cart_details

object

An object that contains cart details.

Note: If cart details are provided, cart information will be displayed during checkout.

Headers

Content-Type

string

The type of content included in the HTTP message body.

Possible value: application/json.

Authorization

string

required

Defaults to Bearer

The HTTP header where you can include your secret token for authentication.

Example: Bearer <access_token>

Note: Use the access token generated using our Generate Token API.

Request-Timestamp

string

Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.

Example: 2024-07-09T07:57:08.022Z

Request-ID

string

Use a global unique identifier [GUID] for the request.

Minimum: 1 characters.
Maximum: 50 characters

Example: c17ce30f-f88e-4f81-ada1-c3b4909ed235

Responses

Environment

📘Note:

200200

500500

📘
Note: