Settlement Details Range API provides transaction level data for a given date or date range. This API returns paginated response for the given input page and page size.
Environment
| Production Environment | https://info.payu.in/settlement/range |
Note: Use the endpoint as per above https://<environment base URL>/settlement/range and do not append slash (/) at the end of it.
Request Parameters
Header Parameters
| Parameter | Description |
|---|---|
| date | The current date and time. For example, format of the date is Wed, 28 Jun 2023 11:25:19 GMT. |
| authorization | The actual HMAC signature generated using the specified algorithm (sha512) and includes the hashed data. For more information, refer to authorization fields description table below. |
authorization fields description
| Parameter | Description |
|---|---|
| username | Represents the username or identifier for the client or merchant, in this case, it's "smsplus". |
| algorithm | Use SHA512 algorithm for hashing and send this as header value. |
| headers | Specifies which headers have been used in generating the hash. In this case, only the "date" header is used. |
| signature | The actual HMAC signature generated using the specified algorithm (sha512) and includes the hashed data. For more information, refer to hashing algorithm. |
hashing algorithm
You must hash the request parameters using the following hash logic:
sha512(<Body data> + '|' + date + '|' + merchant_secret}Where, <Body data> contains the request Body posted with the request.
Sample authorization header code
var merchant_key = '<merchant_key>';
var merchant_secret = '<merchant_salt>';
// date
var date = new Date();
// var date = "Wed, 28 Jun 2023 11:25:19 GMT";
date = date.toUTCString();
// authorization
var authorization = getAuthHeader(date);
console.log(authorization);
function getAuthHeader(date) {
var AUTH_TYPE = 'sha512';
var data = isEmpty(request['data'])?"":request['data'];
var hash_string = data + '|' + date + '|' + merchant_secret;
console.log("Hash String is ", hash_string);
var hash = CryptoJS.SHA512(hash_string).toString(CryptoJS.enc.Hex);
var authHeader = 'hmac username="' + merchant_key + '", ' + 'algorithm="' + AUTH_TYPE + '", headers="date", signature="' + hash + '"'
return authHeader;
}
pm.environment.set('date', date);
pm.environment.set('authorization', authorization);
pm.environment.set('merchant_key',merchant_key);
pm.environment.set('merchant_secret',merchant_secret);
function isEmpty(obj) {
for(var key in obj) {
if(obj.hasOwnProperty(key))
return false;
}
return true;
}Query Parameters
| Parameter | Description | Example |
|---|---|---|
dateFrommandatory | String Start date in YYYY-MM-DD format. | 2025-08-26 |
dateTooptional | String End date in YYYY-MM-DD format. If not provided, defaults to dateFrom. Max range: 3 days. | 2025-08-26 |
pageSizeoptional | Integer Number of records per page. Default: 100, Max: 50000. | 2 |
pageoptional | Integer Page number for pagination. Default: 1. | 2 |
merchantIdoptional | Integer Merchant identifier provided by PayU while onboarding | 454541 |
Sample Request
curl --location 'https://apitest.payu.in/settlement/range?dateFrom=2025-08-26&dateTo=2025-08-26&page=1&pageSize=2' \
--header 'Authorization: {{authorization}}' \
--header 'Date: {{date}}'Sample Response
Success Response with UTR-Level Breakdown
{
"status": 0,
"result": {
"page": 1,
"size": 2,
"totalCount": 2,
"data": [
{
"settlementId": "12127298202508260245",
"settlementCompletedDate": "2025-08-26 02:51:22.000000",
"settlementAmount": "1479.82",
"merchantId": 12127298,
"utrNumber": "523871332950",
"transactionAmount": "2480.0",
"adjustmentAmount": "-987.31",
"refundAmount": "0.0",
"chargebackAmount": "0.0",
"refundReversalAmount": "0.0",
"chargebackReversalAmount": "0.0",
"serviceFee": "0.0",
"serviceTax": "0.0",
"additionalServiceFee": "10.91",
"additionalServiceTax": "1.96",
"numberOfTransactions": 1,
"transaction": [
{
"action": "capture",
"payuId": "24868774786",
"requestId": "18044765028",
"transactionAmount": "2480.0",
"merchantServiceFee": "0.00000",
"merchantServiceTax": "0.00000",
"merchantNetAmount": "2467.13",
"sgst": "0.00000",
"cgst": "0.00000",
"igst": "0.00000",
"merchantTransactionId": "rXNmuNziG9X6UuP7LM9Imt3li",
"mode": "UPI",
"paymentStatus": "captured",
"transactionDate": "2025-08-26 02:14:35.000000",
"requestDate": "2025-08-26 02:15:28.000000",
"requestedAmount": "2480.0",
"bankName": "INTENT",
"offerServiceFee": "0.00",
"offerServiceTax": "0.00",
"forexAmount": "0.0",
"discount": "0.0",
"additionalTdrFee": "10.91",
"totalServiceTax": "1.96000",
"transactionCurrency": "INR",
"settlementCurrency": "INR",
"totalProcessingFee": "10.91000",
"additionalTdrTax": "1.96"
},
{
"action": "ADJ_debit",
"payuId": "ADJ_2574282",
"transactionAmount": "987.31",
"merchantNetAmount": "",
"sgst": "",
"cgst": "",
"igst": "",
"merchantTransactionId": "ADJ_2574282",
"cardType": "",
"mode": "debit",
"paymentStatus": "settled",
"transactionDate": "2025-08-26 02:26:35",
"requestDate": "2025-08-26 02:26:35",
"requestedAmount": "987.31",
"bankName": "",
"token": "",
"forexAmount": "0.0",
"transactionCurrency": "INR",
"settlementCurrency": "INR"
}
]
}
]
}
}Failure Scenarios
No Data Found
{
"status": 1,
"message": "No data found",
"result": "No data found"
}Exceeds Date Range Limit
{
"status": 1,
"message": "Date range exceeds maximum limit of 3 days",
"result": null
}Authorization Failed Response
{
"status": 1,
"message": "Unauthorized: Invalid signature",
"result": null
}Response Parameters
| Parameter | Description |
|---|---|
| status | Response status and it returns either 1 or 0, where 0=Success and 1=Failure. |
| msg | Response message |
| data | Main response data container in a JSON format. For more information, refer to data JSON Fields Description |
data JSON Fields description
| Field | Description | Example |
|---|---|---|
| settlementId | Unique identifier for the settlement batch. string | 12127298202508260245 |
| settlementCompletedDate | Date and time when settlement was completed. string | 2025-08-26 02:51:22.000000 |
| settlementAmount | Final net amount settled to the merchant after all deductions. string | 1479.82 |
| merchantId | Unique identifier of the merchant. integer | 12127298 |
| utrNumber | Unique Transaction Reference number — bank reference for the fund transfer. string | 523871332950 |
| transactionAmount | Gross transaction amount before any deductions (at UTR/settlement level). string | 2480.0 |
| adjustmentAmount | Total adjustment amount applied (negative for debits, positive for credits). string | -987.31 |
| refundAmount | Total amount deducted due to refunds. string | 0.0 |
| chargebackAmount | Total amount deducted due to chargebacks. string | 0.0 |
| refundReversalAmount | Amount credited back due to refund reversals. string | 0.0 |
| chargebackReversalAmount | Amount credited back due to chargeback reversals. string | 0.0 |
| serviceFee | Standard processing fee charged by PayU for the settlement/UTR. string | 0.0 |
| serviceTax | GST/Tax on the service fee. string | 0.0 |
| additionalServiceFee | Additional service fee (e.g., TDR or other extra fees) applied at UTR level. string | 10.91 |
| additionalServiceTax | GST/Tax on the additional service fee. string | 1.96 |
| numberOfTransactions | Count of successful capture transactions included in this settlement/UTR. integer | 1 |
| additionalTdrFee | Additional TDR (Transaction Discount Rate) fee applied. string | 10.91 |
| additionalTdrTax | Tax on the additional TDR fee. string | 1.96 |
| totalServiceTax | Total tax amount (sum of SGST + CGST + IGST) applicable to fees. string | 1.96000 |
| totalProcessingFee | Total processing fee including all components (standard + additional). string | 10.91000 |
| transactionCurrency | Currency of the original transaction (e.g., INR). string | INR |
| settlementCurrency | Currency in which the settlement is made. string | INR |
| transaction | transaction details in a JSON format. For more information, refer to transaction JSON Fields Description. |
transaction JSON Fields Description
| Parameter | Description | Example |
|---|---|---|
| action | Type of transaction (capture, refund, chargeback). string | capture |
| payuId | PayU's unique transaction identifier. string | 24868774786 |
| requestId | Internal request identifier for the transaction. string | 18044765028 |
| transactionAmount | Amount of the individual transaction (gross). string | 2480.0 |
| merchantServiceFee | Service fee charged for this transaction. string | 0.00000 |
| merchantServiceTax | Tax on the service fee for this transaction. string | 0.00000 |
| merchantNetAmount | Net amount after deducting fees and taxes for this transaction. string | 2467.13 |
| sgst | State GST component of the tax. string | 0.00000 |
| cgst | Central GST component of the tax. string | 0.00000 |
| igst | Integrated GST component (for inter-state transactions). string | 0.00000 |
| merchantTransactionId | Merchant's own reference ID for the transaction. string | rXNmuNziG9X6UuP7LM9Imt3li |
| mode | Payment mode used (UPI, CC, DC, NB, WALLET, debit, credit). string | UPI |
| paymentStatus | Current status of the transaction (captured, settled, refund). string | captured |
| transactionDate | Date and time when the transaction was initiated. string | 2025-08-26 02:14:35 |
| requestDate | Date and time when the transaction request was created. string | 2025-08-26 02:15:28 |
| requestedAmount | Original amount requested in the transaction. string | 2480.0 |
| bankName | Name of the bank or payment gateway (e.g., HDFC, AXIS). string | INTENT |
| cardType | Type of card used (VISA, MASTERCARD) — applicable for card payments. string | |
| token | Tokenized card reference (if card tokenization is enabled). string | |
| offerServiceFee | Fee related to offers/discounts applied. string | 0.00 |
| offerServiceTax | Tax on the offer service fee. string | 0.00 |
| forexAmount | Foreign exchange amount (for international transactions). string | 0.0 |
| discount | Discount amount applied on the transaction. string | 0.0 |
| additionalTdrFee | Additional TDR (Transaction Discount Rate) fee. string | 10.91 |
| additionalTdrTax | Tax on the additional TDR fee. string | 1.96 |
| totalServiceTax | Total tax amount (SGST + CGST + IGST). string | 1.96000 |
| totalProcessingFee | Total processing fee including all components. string | 10.91000 |
| transactionCurrency | Currency of the original transaction. string | INR |
| settlementCurrency | Currency in which settlement is made. string | INR |