Get All Settlement Reports

GET/api/settlements/v1/list

Retrieves all settlements within a specified date range.

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.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Query Parameters

Field	Details
`start_date` `string`required	Start date for settlement retrieval.
`end_date` `string`required	End date for settlement retrieval.
`page` `string`	Page number to retrieve.
`per_page` `string`	Number of records per page (max 10).

Response

Field	Details
`data` `SettlementSummary[]`11 nested fields	Array of settlement summary objects.
`total_amount` `number`	Total settlement amount.
`actual_transaction_amount` `number`	Total transaction amount without deductions.
`total_deduction_amount` `number`	Total deduction amount.
`total_transactions_count` `integer`	Total number of transactions settled within this UTR.
`last_processed_date` `string`	Date when transactions were last processed for settlement.
`settled_date` `string`	Date on which the batch was settled.
`utr_number` `string`	Unique Transaction Reference generated for the settlement.
`programs` `string[]`	Payment programs included in this settlement.
`system` `string`	Constant system identifier.
`bank_name` `string`	Settlement bank name. Constraints Minimum length: 1 characterMaximum length: 50 characters
`bank_acc_number` `string`	Settlement bank account number. Constraints Minimum length: 1 characterMaximum length: 50 characters
`total_settlement_count` `integer`	Total number of settlements matching the query.
`total_transactions_count` `integer`	Total number of transactions across all settlements.
`total_settlement_amount` `number`	Total settlement amount across all settlements.

Status Codes

`200`	Settlements 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.

Run

Request

curl --request GET \
  --url 'https://pluraluat.v2.pinepg.in/api/settlements/v1/list?start_date=2024-10-01&end_date=2024-10-09&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'

Status:

{
  "data": [
    {
      "total_amount": 0.96,
      "actual_transaction_amount": 2,
      "total_deduction_amount": 0.08,
      "total_transactions_count": 2,
      "last_processed_date": "2024-10-09T07:00:00",
      "settled_date": "2024-10-09T10:59:46",
      "utr_number": "410092786849",
      "programs": [
        "UPI"
      ],
      "system": "PG",
      "bank_name": "HDFC Bank Ltd",
      "bank_acc_number": "04992990009595"
    },
    {
      "total_amount": 0.98,
      "actual_transaction_amount": 1,
      "total_deduction_amount": 0.04,
      "total_transactions_count": 1,
      "last_processed_date": "2024-10-08T07:00:00",
      "settled_date": "2024-10-08T11:16:40",
      "utr_number": "410080488411",
      "programs": [
        "UPI"
      ],
      "system": "PG",
      "bank_name": "HDFC Bank Ltd",
      "bank_acc_number": "04992990009595"
    },
    {
      "total_amount": 0.96,
      "actual_transaction_amount": 2,
      "total_deduction_amount": 0.08,
      "total_transactions_count": 2,
      "last_processed_date": "2024-10-07T07:00:00",
      "settled_date": "2024-10-07T11:36:44",
      "utr_number": "410077587729",
      "programs": [
        "UPI"
      ],
      "system": "PG",
      "bank_name": "HDFC Bank Ltd",
      "bank_acc_number": "04992990009595"
    },
    {
      "total_amount": 3.92,
      "actual_transaction_amount": 4,
      "total_deduction_amount": 0.16,
      "total_transactions_count": 4,
      "last_processed_date": "2024-10-06T07:00:00",
      "settled_date": "2024-10-07T10:48:02",
      "utr_number": "410077424703",
      "programs": [
        "UPI"
      ],
      "system": "PG",
      "bank_name": "HDFC Bank Ltd",
      "bank_acc_number": "04992990009595"
    },
    {
      "total_amount": 0.98,
      "actual_transaction_amount": 1,
      "total_deduction_amount": 0.04,
      "total_transactions_count": 1,
      "last_processed_date": "2024-10-05T07:00:00",
      "settled_date": "2024-10-05T10:58:12",
      "utr_number": "410055402704",
      "programs": [
        "UPI"
      ],
      "system": "PG",
      "bank_name": "HDFC Bank Ltd",
      "bank_acc_number": "04992990009595"
    },
    {
      "total_amount": 1.94,
      "actual_transaction_amount": 3,
      "total_deduction_amount": 0.12,
      "total_transactions_count": 3,
      "last_processed_date": "2024-10-04T06:32:13",
      "settled_date": "2024-10-04T11:14:39",
      "utr_number": "410041942381",
      "programs": [
        "UPI"
      ],
      "system": "PG",
      "bank_name": "HDFC Bank Ltd",
      "bank_acc_number": "04992990009595"
    },
    {
      "total_amount": 0.98,
      "actual_transaction_amount": 1,
      "total_deduction_amount": 0.04,
      "total_transactions_count": 1,
      "last_processed_date": "2024-10-03T06:35:20",
      "settled_date": "2024-10-03T10:58:43",
      "utr_number": "410039900271",
      "programs": [
        "UPI"
      ],
      "system": "PG",
      "bank_name": "HDFC Bank Ltd",
      "bank_acc_number": "04992990009595"
    }
  ],
  "total_settlement_count": 7,
  "total_transactions_count": 14,
  "total_settlement_amount": 10.72
}