Date Range Based Settlement IDs

The Date Range Based Settlement IDs API allows merchants to fetch a list of settlement IDs by providing a specific time window using from and to timestamps. This helps in tracking all settlements processed within a given range.

Environment

Environment	HTTP Header	API
`Sandbox`	`GET`	https://api-preprod.phonepe.com/apis/pg-sandbox/settlements/v1/range?from=1723107864177&to=1723107864187&limit=10&offset=0
`Production`	`GET`	https://api.phonepe.com/apis/pg/settlements/v1/range?from=1723107864177&to=1723107864187&limit=10&offset=0

Request

Request Headers

Header Name	Header Value
`Content-Type`	application/json
`Authorization`	O-Bearer <access_token>

⚠️ For Partner Integrations!

It is mandatory to include the X-MERCHANT-ID header with the MerchantID of the end merchant.

Query Parameter Details

Parameter Name	Description
from	from timestamp in Epoch milliseconds	Not Null, older than 6 months is not accepted
to	to timestamp in Epoch milliseconds	Not Null, older than 6 months is not accepted
limit	number of records that be fetched in the single API call. Note: Max supported limit is 40	Default to 10
offset	offset for pagination	Default to 0

Response

Sample Response

{
  "settlements": [
    {
      "state": "PROCESSED",
      "settlementId": "abca-defa-kadi-dald",
      "utr": "UTR0001",
      "date": 1723107864177
    },
    {
      "state": "PROCESSED",
      "settlementId": "abca-defa-kadi-daal",
      "utr": "UTR0002",
      "date": 1635769200000
    }
  ],
  "hasNext" : true
}

Response Parameters

Parameter Name	Type	Description
`settlementId`	String	Settlement Id generated by PhonePe
`state`	String	Current State of the settlement • INITIATED • PROCESSED • ATTEMPT_FAILED
`utr`	String	UTR reference of the settlement
`date`	Epoch	Timestamp
`hasNext`	Boolean	True: If more records are present