Create a Payment Link API

post

https://uatoneapi.payu.in/payment-links

Body Params

invoiceNumber

string

This parameter contains the unique string which is used for identifying a payment link. This must be alphanumeric.

isAmountFilledByCustomer

boolean

Defaults to false

This parameter contains any of the following values to specify whether it is an open invoices (when customer fills amount) or fixed amount: * true - It is an open invoice where the customer can fill the amount. The subamount parameter must be null in this case. * false - It is closed invoice and amount is fixed.

subAmount

integer

This parameter must contain the payment amount when the isAmountFilledByCustomer parameter is set to false. The value must be greater than or equal to 1.

minAmountForCustomer

integer

This parameter contains the minimum amount a customer needs to pay in case of partial payment.

tax

integer

This parameter must contain the tax amount for the payment transaction. This value must be greater than zero.

shippingCharge

integer

This parameter must contain the shipping charges if any,

discount

integer

This parameter must contains the discount given for the customer if any,

adjustment

integer

This parameter must contains the adjustment amount if any,

description

string

required

This parameter must contain the description or purpose of creating the.payment link.

source

string

required

This parameter contains the source of payment generation. For a regular payment link it needs to be passed as "API" and for SI payment links as "si_payment_link"

isPartialPaymentAllowed

boolean

This parameter indicates whether partial payments allowed using the payment link sent.

currency

string

This parameter contains the currency code of the currency that is used for collecting the amount.

maxPaymentsAllowed

integer

This parameter contains the max number of payments allowed using the payment link shared by the merchant. For example, you can share same payment link to 10 customers or 100 customers based on the requirement.

batchId

string

This parameter contains the batch ID of the payment link.

expiryDate

string

This parameter contains the expiry date of the payment link in the format (will be 365 days in all other cases). For exaample, 2016-06-23 09:07:21

scheduledFor

string

This parameter contains the reason for scheduling this payment link.

customer

object

address

object

udf

object

viaEmail

boolean

This parameter is set to true to send the payment link via the email upon generation. Else, set to false so that email is not sent.

viaSms

boolean

This parameter is set to true to send the payment link via the SMS upon generation. Else, set to false so that SMS is not sent.

emailTemplateName

string

This parameter is contains the email template name that will be used when sending email.

smsTemplateName

string

This parameter is contains the SMS template name that will be used when sending SNS.

timeUnit

string

This parameter is contains the time unit used that is used while specifying the expiryDate.

notes

string

This parameter is contains the custom notes about the payment link.

successURL

string

The success URL, which is the page PayU will redirect to if the transaction is successful.

failureURL

string

The failure URL, which is the page PayU will redirect to if the transaction is failed.

customAttributes

array of objects

This parameter contains the customAttribute details in a JSON format.

customAttributes

dropCategory

string

This parameter can be used if you want to hide one or multiple payment options. For example, if you want to collect the payment using debit card and Net Banking, you can hide the credit card mode of payment.

enforcePayMethod

string

This parameter allows you to customize the payment options for each transaction. You can enforce specific payment modes, cards scheme, and specific banks under Net Banking using this method. For SI, the enforce payment methods supported: enach, creditcard, debitcard, upi. To create a seamless eNACH payment link, the enforcePayMethod with "enach" as the only method should be passed.

enforcePG

string

This parameter allows you to enforce only a specific payment mode that you prefer.

userToken

string

This parameter must contain the user token if you are using a token for authentication.

userCredentials

string

This parameter must contain the user credentials if you are credetails for authentication.

transactionId

string

This parameter must contain the transaction ID of the transaction at the time of payment.

cart_details

object

aggregatorSplitInfo

object

validationPeriod

string

This parameter must contain the validation period of the transaction.

siDetails

object

This object contains the SI details.

smsConfirm

string

This parameter contains the SMS confirmation received.

isActive

string

This parameter is used to specify whether the payment link is active. Specify true if it is active.

Headers

mid

string

required

This parameter must contain the invoice ID.

Response

200

EXAMPLE QUESTIONS