Get Settlement Details by UTR Number
/api/settlements/v1/detail/{utr}Retrieves detailed settlement information for a specific UTR (Unique Transaction Reference).
Notes:
- Maximum date range for retrieving settlement data is 60 days.
- API supports a maximum of 10 records per page, one page at a time.
Bearer token. Get token →Path Parameters
| Field | Details |
|---|---|
utrstringrequired | Unique Transaction Reference number. Constraints Maximum length: 50 characters |
Header Parameters
| Field | Details |
|---|---|
Request-Timestampstringdate-time | ISO 8601 UTC timestamp of the request. Used for idempotency and audit. |
Request-IDstring | Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters |
Query Parameters
| Field | Details |
|---|---|
pagestring | Page number to retrieve. |
per_pagestring | Number of records per page (max 10). |
Response
| Field | Details |
|---|---|
utr_numberstring | Unique Transaction Reference provided by the bank. Constraints Maximum length: 50 characters |
bank_namestring | Settlement bank name. |
bank_acc_numberstring | Settlement bank account number. |
programsstring[] | |
total_transaction_countinteger | Total number of transactions in this UTR. |
total_transaction_amountnumber | Total transaction amount settled after deductions. |
actual_transaction_amountnumber | Total transaction amount without deductions. |
total_refundnumber | Total refund amount deducted. |
total_chargeback_recovery_amountnumber | Total chargeback recovery amount. |
total_loan_recovery_amountnumber | Total loan recovery amount. |
total_mdr_amountnumber | Total MDR (Merchant Discount Rate) amount. |
total_gst_amountnumber | Total GST amount charged. |
total_late_settlement_feenumber | Total late settlement fee. |
total_settled_amountnumber | Total settled amount. |
total_mar_amountnumber | Total Merchant Acquisition Rate charged. |
split_fund_amountnumber | Split amount of the transaction. |
total_platform_feenumber | Total platform fee charged. |
other_deductionsnumber | Other deductions. |
additional_mdr_amountnumber | Additional MDR amount deducted. |
total_convenience_feenumber | Total convenience fee charged. |
total_gst_on_c_c_fnumber | GST charged on convenience fees. |
total_cashback_amountnumber | Total cashback amount provided. |
total_merchant_cashbacknumber | Total merchant cashback amount. |
total_merchant_convenience_feenumber | Total merchant convenience fee. |
transactionsSettlementTransaction[]15 nested fields | Array of individual transaction details. |
transaction_idstring | Unique identifier for the transaction. |
systemstring | Constant system identifier. |
processed_datestring | Date when the transaction was processed. |
transaction_datestring | Date of the transaction. |
transaction_amountnumber | Transaction amount. |
actual_transaction_amountnumber | Total transaction amount without deductions. |
total_deduction_amountnumber | Total deduction amount. |
settled_amountnumber | Settled amount for this transaction. |
store_addressstring | Address of the store (applicable for POS transactions). |
acquirer_namestring | Name of the acquirer. |
tidstring | Terminal ID for the transaction. |
is_emiboolean | Whether the transaction was an EMI. |
utr_numberstring | UTR number. Constraints Maximum length: 50 characters |
programstring | Payment method used. |
payout_statusstring | Status of the payout. |
paginationobject2 nested fields |
Status Codes
200 | Settlement details retrieved successfully. |
400 | The request was malformed or missing required fields. |
401 | Authentication failed — missing, expired, or invalid Bearer token. |
500 | An unexpected error occurred on the server. |
curl --request GET \
--url 'https://pluraluat.v2.pinepg.in/api/settlements/v1/detail/410092786849?page=1&per_page=10' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
--header 'Request-Timestamp: 2024-10-01T10:30:00Z'{
"utr_number": "410092786849",
"bank_name": "HDFC Bank Ltd",
"bank_acc_number": "04992990009595",
"programs": [
"UPI"
],
"total_transaction_count": 2,
"total_transaction_amount": 2,
"actual_transaction_amount": 2,
"total_refund": 0,
"total_chargeback_recovery_amount": 0,
"total_loan_recovery_amount": 0,
"total_mdr_amount": 0.04,
"total_gst_amount": 0,
"total_late_settlement_fee": 0,
"total_settled_amount": 0.96,
"total_mar_amount": 0,
"split_fund_amount": 0,
"total_platform_fee": 0,
"other_deductions": 0,
"additional_mdr_amount": 0,
"total_convenience_fee": 0,
"total_gst_on_c_c_f": 0,
"total_cashback_amount": 0,
"total_merchant_cashback": 0,
"total_merchant_convenience_fee": 0,
"transactions": [
{
"transaction_id": "v1-241008182747-aa-8JwMy9-up-k",
"system": "PG",
"processed_date": "2024-10-09T07:00:00",
"transaction_date": "2024-10-08T00:00:00",
"transaction_amount": 1,
"actual_transaction_amount": 1,
"total_deduction_amount": 0.02,
"settled_amount": 0,
"store_address": "sec 62 noida",
"acquirer_name": "UPI_HDFC",
"tid": "HDFC000028502654",
"is_emi": false,
"utr_number": "410092786849",
"program": "UPI",
"payout_status": "Success"
},
{
"transaction_id": "v1-241008182412-aa-rnfH9Q-up-F",
"system": "PG",
"processed_date": "2024-10-09T07:00:00",
"transaction_date": "2024-10-08T00:00:00",
"transaction_amount": 1,
"actual_transaction_amount": 1,
"total_deduction_amount": 0.02,
"settled_amount": 0.96,
"store_address": "sec 62 noida",
"acquirer_name": "UPI_HDFC",
"tid": "HDFC000028502654",
"is_emi": false,
"utr_number": "410092786849",
"program": "UPI",
"payout_status": "Success"
}
],
"pagination": {
"total_pages": 2,
"current_page": "1"
}
}