Settlement Status

Use the Settlement Status API to check the current status of a settlement using the settlementId received from the webhook. This helps you track if the settlement is INITIATED, PROCESSED, or ATTEMPT_FAILED. In case of a failure, the response includes the error code and description. You can also view details like amount, UTR, and the last updated timestamp.

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 <access_token>

⚠️ For Partner Integrations!

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

Path Parameter Details

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",
  "lastAttemptErrorCode": "",
  "lastAttemptErrorDescription" : "",
  "lastUpdatedAt" : 121211331
}

Response Parameters

Parameter Name	Type	Description
`settlementId`	String	Unique ID generated by PhonePe for the settlement.
`state`	String	Current status of the settlement. Possible values: • INITIATED • PROCESSED • ATTEMPT_FAILED
`utr`	String	UTR associated with the settlement.
`amount`	Long	Settlement Amount
`merchantId`	String	Merchant ID for which the settlement was created.
`lastAttemptErrorCode`	String	Error code for the failed attempt. Present only if the `state` is ATTEMPT_FAILED.
`lastAttemptErrorDescription`	String	Description of the failure reason. Present only if the `state` is ATTEMPT_FAILED.
`lastUpdatedAt`	DateTime	Timestamp (in epoch milliseconds) of the latest update to the settlement status.