Settlement Status
Settlement Status API is used to fetch the current status of a settlement using the settlementId received in the webhook response. It provides real-time updates on the settlement state, including information such as UTR, settlement amount, account ID, and timestamps. This helps track the final processing status of a split settlement across associated accounts.
Environment
| Environment | HTTP Method | API |
|---|---|---|
Sandbox | GET | https://api-preprod.phonepe.com/apis/pg-sandbox/settlements/v1/{settlementId}/status |
Production | GET | https://api.phonepe.com/apis/pg/settlements/v1/{settlementId}/status |
Request
Request Headers
| Header Name | Header Value |
| Content-Type | application/json |
| Authorization | O-Bearer <partner-auth-token> |
| X-MERCHANT-ID | MID |
Path Parameter
| Parameter Name | Description |
|---|---|
settlementId | settlement ID received in the Webhook response. |
Response
Sample Response
{
"settlementId" : "abca-defa-kadi-dald",
"state" : INITIATED,
"utr" : "UTR100291",
"amount" : 100,
"merchantId" : "merchantId",
"accountId": "B12345678",
"lastAttemptErrorCode": "",
"lastAttemptErrorDescription" : "",
"lastUpdatedAt" : 121211331
}Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
settlementId | String | Unique settlement ID generated by PhonePe. |
| String | Current status of the settlement. Possible values: • INITIATED • PROCESSED • ATTEMPT_FAILED |
| String | UTR reference number associated with the settlement. |
| Long | Total amount settled. |
| String | Merchant ID for whom the settlement has been initiated. |
| String | Account ID associated with the merchant. |
| String | Present only if the settlement state is ATTEMPT_FAILED. Indicates the error code of the failed attempt. |
| String | Present only if the settlement state is ATTEMPT_FAILED. Provides the error description of the failed attempt. |
| DateTime | Timestamp of the most recent update to the settlement status, in epoch (milliseconds) |