get
https://uatoneapi.payu.in/payment-links/
Use this endpoint to retrieve the current state and all details of a payment link by its invoiceNumber.
Check whether a link is active, verify its amount and configuration, or poll for status after a customer interaction.
Method
GET
Endpoint
/payment-links/{invoiceNumber}
Environments
| Environment | URL |
|---|---|
| Test Environment | https://uatoneapi.payu.in |
| Production Environment | https://oneapi.payu.in |
Get your Bearer token before calling this endpointThis API uses OAuth 2.0 authentication.
- Call the Generate an Access Token token with
grant_type=client_credentialsandscope=create_payment_links- Copy the
access_tokenfrom the response- Pass it as
Authorization: Bearer {access_token}in every requestToken Expiry: Check
expires_inin the token response and refresh before it lapses.
Sample Request
curl --location 'https://uatoneapi.payu.in/payment-links/{{invoice_number}}' \
--header 'merchantId: {{merchantId}}' \
--header 'Authorization: Bearer {{access_token}}'import requests
url = "https://uatoneapi.payu.in/payment-links"
headers = {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"merchantId": "YOUR_MERCHANT_ID",
"Content-Type": "application/json"
}
payload = {
"subAmount": 1499,
"description": "Order #ORD-2026-88421",
"source": "API",
"invoiceNumber": "ORD-2026-88421",
"expiryDate": "2026-10-15 23:59:59",
"currency": "INR",
"tax": 0,
"shippingCharge": 0,
"discount": 0,
"adjustment": 0,
"maxPaymentsAllowed": 1,
"isAmountFilledByCustomer": false,
"isPartialPaymentAllowed": false,
"minAmountForCustomer": 500,
"viaEmail": true,
"viaSms": true,
"viaWhatsapp": false,
"enforcePayMethod": "",
"dropCategory": "",
"successURL": "https://yoursite.com/success",
"failureURL": "https://yoursite.com/failure",
"customer": {
"name": "Arjun Mehta",
"email": "[email protected]",
"phone": "9876543210"
},
"address": {
"line1": "123 MG Road",
"line2": "Apt 4B",
"city": "Bengaluru",
"state": "Karnataka",
"zipCode": "560001"
},
"udf": {
"udf1": "electronics",
"udf2": "app-checkout",
"udf3": "",
"udf4": "",
"udf5": ""
},
"siDetails": {
"billingAmount": 999,
"billingCycle": "MONTHLY",
"billingInterval": 12,
"paymentStartDate": "2026-10-01",
"paymentEndDate": "2027-09-30",
"isNoExpiry": false,
"isFreeTrial": false,
"remarks": "Monthly subscription",
"billingCurrency": "INR",
"bankDetails": {
"bankCode": "HDFC",
"bankAccountNumber": "50100123456789",
"ifsc": "HDFC0001234",
"accountType": "SAVINGS"
}
},
"paymentDeadline": "2026-10-20 23:59:59",
"reminder": {
"isScheduled": true,
"type": 0,
"channels": [
"email",
"phone"
]
},
"whatsappRecipients": [
{
"phone": "9876543210"
}
],
"whatsappTemplateName": "payment_link_template",
"offerKey": "FEST20OFF",
"blockDaysForPreAuthorizeLinks": 3,
"beneficiarydetail": {
"beneficiaryAccountNumber": [
"123456789012"
],
"ifscCode": [
"HDFC0001234"
],
"beneficiaryName": [
"Arjun Mehta"
],
"beneficiaryAccountType": [
"SAVINGS"
]
},
"batchId": "BATCH-2026-001",
"notes": "Internal reference note",
"transactionId": "TXN-2026-88421",
"customAttributes": [
{
"key": "orderId",
"value": "ORD-88421"
}
],
"additionalDetails": {
"amountStatus": "UNPAID",
"sendWhatsapp": false,
"partnerWebhookSuccessUrls": "https://partner.example.com/webhook/success",
"partnerWebhookFailureUrls": "https://partner.example.com/webhook/failure"
}
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())using System;
using System.Net.Http;
using System.Text;
using Newtonsoft.Json;
class Program
{
static async Task Main(string[] args)
{
var client = new HttpClient();
var url = "https://uatoneapi.payu.in/payment-links";
var headers = new Dictionary<string, string>
{
{ "Authorization", "Bearer YOUR_ACCESS_TOKEN" },
{ "merchantId", "YOUR_MERCHANT_ID" },
{ "Content-Type", "application/json" }
};
foreach (var header in headers)
client.DefaultRequestHeaders.Add(header.Key, header.Value);
var json = JsonConvert.SerializeObject({
"subAmount": 1499,
"description": "Order #ORD-2026-88421",
"source": "API",
"invoiceNumber": "ORD-2026-88421",
"expiryDate": "2026-10-15 23:59:59",
"currency": "INR",
"tax": 0,
"shippingCharge": 0,
"discount": 0,
"adjustment": 0,
"maxPaymentsAllowed": 1,
"isAmountFilledByCustomer": false,
"isPartialPaymentAllowed": false,
"minAmountForCustomer": 500,
"viaEmail": true,
"viaSms": true,
"viaWhatsapp": false,
"enforcePayMethod": "",
"dropCategory": "",
"successURL": "https://yoursite.com/success",
"failureURL": "https://yoursite.com/failure",
"customer": {
"name": "Arjun Mehta",
"email": "[email protected]",
"phone": "9876543210"
},
"address": {
"line1": "123 MG Road",
"line2": "Apt 4B",
"city": "Bengaluru",
"state": "Karnataka",
"zipCode": "560001"
},
"udf": {
"udf1": "electronics",
"udf2": "app-checkout",
"udf3": "",
"udf4": "",
"udf5": ""
},
"siDetails": {
"billingAmount": 999,
"billingCycle": "MONTHLY",
"billingInterval": 12,
"paymentStartDate": "2026-10-01",
"paymentEndDate": "2027-09-30",
"isNoExpiry": false,
"isFreeTrial": false,
"remarks": "Monthly subscription",
"billingCurrency": "INR",
"bankDetails": {
"bankCode": "HDFC",
"bankAccountNumber": "50100123456789",
"ifsc": "HDFC0001234",
"accountType": "SAVINGS"
}
},
"paymentDeadline": "2026-10-20 23:59:59",
"reminder": {
"isScheduled": true,
"type": 0,
"channels": [
"email",
"phone"
]
},
"whatsappRecipients": [
{
"phone": "9876543210"
}
],
"whatsappTemplateName": "payment_link_template",
"offerKey": "FEST20OFF",
"blockDaysForPreAuthorizeLinks": 3,
"beneficiarydetail": {
"beneficiaryAccountNumber": [
"123456789012"
],
"ifscCode": [
"HDFC0001234"
],
"beneficiaryName": [
"Arjun Mehta"
],
"beneficiaryAccountType": [
"SAVINGS"
]
},
"batchId": "BATCH-2026-001",
"notes": "Internal reference note",
"transactionId": "TXN-2026-88421",
"customAttributes": [
{
"key": "orderId",
"value": "ORD-88421"
}
],
"additionalDetails": {
"amountStatus": "UNPAID",
"sendWhatsapp": false,
"partnerWebhookSuccessUrls": "https://partner.example.com/webhook/success",
"partnerWebhookFailureUrls": "https://partner.example.com/webhook/failure"
}
});
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var responseContent = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseContent);
}
}const url = "https://uatoneapi.payu.in/payment-links";
const headers = {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"merchantId": "YOUR_MERCHANT_ID",
"Content-Type": "application/json"
};
const payload = {
"subAmount": 1499,
"description": "Order #ORD-2026-88421",
"source": "API",
"invoiceNumber": "ORD-2026-88421",
"expiryDate": "2026-10-15 23:59:59",
"currency": "INR",
"tax": 0,
"shippingCharge": 0,
"discount": 0,
"adjustment": 0,
"maxPaymentsAllowed": 1,
"isAmountFilledByCustomer": false,
"isPartialPaymentAllowed": false,
"minAmountForCustomer": 500,
"viaEmail": true,
"viaSms": true,
"viaWhatsapp": false,
"enforcePayMethod": "",
"dropCategory": "",
"successURL": "https://yoursite.com/success",
"failureURL": "https://yoursite.com/failure",
"customer": {
"name": "Arjun Mehta",
"email": "[email protected]",
"phone": "9876543210"
},
"address": {
"line1": "123 MG Road",
"line2": "Apt 4B",
"city": "Bengaluru",
"state": "Karnataka",
"zipCode": "560001"
},
"udf": {
"udf1": "electronics",
"udf2": "app-checkout",
"udf3": "",
"udf4": "",
"udf5": ""
},
"siDetails": {
"billingAmount": 999,
"billingCycle": "MONTHLY",
"billingInterval": 12,
"paymentStartDate": "2026-10-01",
"paymentEndDate": "2027-09-30",
"isNoExpiry": false,
"isFreeTrial": false,
"remarks": "Monthly subscription",
"billingCurrency": "INR",
"bankDetails": {
"bankCode": "HDFC",
"bankAccountNumber": "50100123456789",
"ifsc": "HDFC0001234",
"accountType": "SAVINGS"
}
},
"paymentDeadline": "2026-10-20 23:59:59",
"reminder": {
"isScheduled": true,
"type": 0,
"channels": [
"email",
"phone"
]
},
"whatsappRecipients": [
{
"phone": "9876543210"
}
],
"whatsappTemplateName": "payment_link_template",
"offerKey": "FEST20OFF",
"blockDaysForPreAuthorizeLinks": 3,
"beneficiarydetail": {
"beneficiaryAccountNumber": [
"123456789012"
],
"ifscCode": [
"HDFC0001234"
],
"beneficiaryName": [
"Arjun Mehta"
],
"beneficiaryAccountType": [
"SAVINGS"
]
},
"batchId": "BATCH-2026-001",
"notes": "Internal reference note",
"transactionId": "TXN-2026-88421",
"customAttributes": [
{
"key": "orderId",
"value": "ORD-88421"
}
],
"additionalDetails": {
"amountStatus": "UNPAID",
"sendWhatsapp": false,
"partnerWebhookSuccessUrls": "https://partner.example.com/webhook/success",
"partnerWebhookFailureUrls": "https://partner.example.com/webhook/failure"
}
};
fetch(url, {
method: "POST",
headers: headers,
body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));import okhttp3.*;
import org.json.JSONObject;
public class PaymentLinkExample {
public static void main(String[] args) throws Exception {
String url = "https://uatoneapi.payu.in/payment-links";
JSONObject payload = new JSONObject({"subAmount": 1499, "description": "Order #ORD-2026-88421", "source": "API", "invoiceNumber": "ORD-2026-88421", "expiryDate": "2026-10-15 23:59:59", "currency": "INR", "tax": 0, "shippingCharge": 0, "discount": 0, "adjustment": 0, "maxPaymentsAllowed": 1, "isAmountFilledByCustomer": false, "isPartialPaymentAllowed": false, "minAmountForCustomer": 500, "viaEmail": true, "viaSms": true, "viaWhatsapp": false, "enforcePayMethod": "", "dropCategory": "", "successURL": "https://yoursite.com/success", "failureURL": "https://yoursite.com/failure", "customer": {"name": "Arjun Mehta", "email": "[email protected]", "phone": "9876543210"}, "address": {"line1": "123 MG Road", "line2": "Apt 4B", "city": "Bengaluru", "state": "Karnataka", "zipCode": "560001"}, "udf": {"udf1": "electronics", "udf2": "app-checkout", "udf3": "", "udf4": "", "udf5": ""}, "siDetails": {"billingAmount": 999, "billingCycle": "MONTHLY", "billingInterval": 12, "paymentStartDate": "2026-10-01", "paymentEndDate": "2027-09-30", "isNoExpiry": false, "isFreeTrial": false, "remarks": "Monthly subscription", "billingCurrency": "INR", "bankDetails": {"bankCode": "HDFC", "bankAccountNumber": "50100123456789", "ifsc": "HDFC0001234", "accountType": "SAVINGS"}}, "paymentDeadline": "2026-10-20 23:59:59", "reminder": {"isScheduled": true, "type": 0, "channels": ["email", "phone"]}, "whatsappRecipients": [{"phone": "9876543210"}], "whatsappTemplateName": "payment_link_template", "offerKey": "FEST20OFF", "blockDaysForPreAuthorizeLinks": 3, "beneficiarydetail": {"beneficiaryAccountNumber": ["123456789012"], "ifscCode": ["HDFC0001234"], "beneficiaryName": ["Arjun Mehta"], "beneficiaryAccountType": ["SAVINGS"]}, "batchId": "BATCH-2026-001", "notes": "Internal reference note", "transactionId": "TXN-2026-88421", "customAttributes": [{"key": "orderId", "value": "ORD-88421"}], "additionalDetails": {"amountStatus": "UNPAID", "sendWhatsapp": false, "partnerWebhookSuccessUrls": "https://partner.example.com/webhook/success", "partnerWebhookFailureUrls": "https://partner.example.com/webhook/failure"}});
OkHttpClient client = new OkHttpClient();
RequestBody body = RequestBody.create(
payload.toString(),
MediaType.parse("application/json")
);
Request request = new Request.Builder()
.url(url)
.addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN")
.addHeader("merchantId", "YOUR_MERCHANT_ID")
.addHeader("Content-Type", "application/json")
.post(body)
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}<?php
$url = "https://uatoneapi.payu.in/payment-links";
$headers = [
"Authorization: Bearer YOUR_ACCESS_TOKEN",
"merchantId: YOUR_MERCHANT_ID",
"Content-Type: application/json"
];
$payload = [
"subAmount" => 1499,
"description" => "Order #ORD-2026-88421",
"source" => "API",
"invoiceNumber" => "ORD-2026-88421",
"expiryDate" => "2026-10-15 23:59:59",
"currency" => "INR",
"tax" => 0,
"shippingCharge" => 0,
"discount" => 0,
"adjustment" => 0,
"maxPaymentsAllowed" => 1,
"isAmountFilledByCustomer" => false,
"isPartialPaymentAllowed" => false,
"minAmountForCustomer" => 500,
"viaEmail" => true,
"viaSms" => true,
"viaWhatsapp" => false,
"enforcePayMethod" => "",
"dropCategory" => "",
"successURL" => "https://yoursite.com/success",
"failureURL" => "https://yoursite.com/failure",
"customer" => [
"name" => "Arjun Mehta",
"email" => "[email protected]",
"phone" => "9876543210"
],
"address" => [
"line1" => "123 MG Road",
"line2" => "Apt 4B",
"city" => "Bengaluru",
"state" => "Karnataka",
"zipCode" => "560001"
],
"udf" => [
"udf1" => "electronics",
"udf2" => "app-checkout",
"udf3" => "",
"udf4" => "",
"udf5" => ""
],
"siDetails" => [
"billingAmount" => 999,
"billingCycle" => "MONTHLY",
"billingInterval" => 12,
"paymentStartDate" => "2026-10-01",
"paymentEndDate" => "2027-09-30",
"isNoExpiry" => false,
"isFreeTrial" => false,
"remarks" => "Monthly subscription",
"billingCurrency" => "INR",
"bankDetails" => [
"bankCode" => "HDFC",
"bankAccountNumber" => "50100123456789",
"ifsc" => "HDFC0001234",
"accountType" => "SAVINGS"
]
],
"paymentDeadline" => "2026-10-20 23:59:59",
"reminder" => [
"isScheduled" => true,
"type" => 0,
"channels" => [
"email",
"phone"
]
],
"whatsappRecipients" => [
[
"phone" => "9876543210"
]
],
"whatsappTemplateName" => "payment_link_template",
"offerKey" => "FEST20OFF",
"blockDaysForPreAuthorizeLinks" => 3,
"beneficiarydetail" => [
"beneficiaryAccountNumber" => [
"123456789012"
],
"ifscCode" => [
"HDFC0001234"
],
"beneficiaryName" => [
"Arjun Mehta"
],
"beneficiaryAccountType" => [
"SAVINGS"
]
],
"batchId" => "BATCH-2026-001",
"notes" => "Internal reference note",
"transactionId" => "TXN-2026-88421",
"customAttributes" => [
[
"key" => "orderId",
"value" => "ORD-88421"
]
],
"additionalDetails" => [
"amountStatus" => "UNPAID",
"sendWhatsapp" => false,
"partnerWebhookSuccessUrls" => "https://partner.example.com/webhook/success",
"partnerWebhookFailureUrls" => "https://partner.example.com/webhook/failure"
]
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_HTTPHEADER => $headers
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>Refer to the Path Params and Headers sections for a full description of all parameters and use cases.
Sample Response
{
"status": 0,
"message": null,
"result": {
"summary": {
"amountRequested": 2,
"totalRevenue": 0,
"totalViews": 0
},
"subAmount": 2,
"tax": 0,
"shippingCharge": 0,
"totalAmount": 2,
"totalAmountCollected": 0,
"invoiceNumber": "INV8446471886220",
"paymentLink": "http://pp72.pmny.in/4IwlctBtwp2V",
"description": "paymentLink for testing",
"active": true,
"isPartialPaymentAllowed": false,
"status": "active",
"expiryDate": "2023-03-21T14:53:52.000+0530",
"udf": {
"udf1": null,
"udf2": null,
"udf3": null,
"udf4": null,
"udf5": null
},
"address": {
"line1": null,
"line2": null,
"city": null,
"state": null,
"country": null,
"zipCode": null
},
"addedOn": "2022-03-21T14:53:53.000+0530",
"isAmountFilledByCustomer": false,
"isScheduled": 0,
"reminderCount": 0,
"customAttributes": []
},
"errorCode": null,
"guid": null
}{
"status": -1,
"message": "paymentLink not found",
"result": null,
"errorCode": null,
"guid": null
}Refer to the Response section for a full description of all response fields.
