Settlement Status

Merchants can call the Settlement Status API to fetch the current status of the Settlement using settlementId received from the webhook.

Host Details

Environment	Value
`UAT`	https://api-preprod.phonepe.com/apis/pg-sandbox
`PROD`	https://api.phonepe.com/apis/pg

API Endpoint

/settlements/v1/{settlementId}/status

Complete Host URL

Http Method: GET

Environment	Value
`UAT`	https://api-preprod.phonepe.com/apis/pg-sandbox/settlements/v1/{settlementId}/status
`PROD`	https://api.phonepe.com/apis/pg/settlements/v1/{settlementId}/status

Request Details

Request Headers

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

Note: access_token can be generated using the Auth Token API. Refer here

Path Parameter Details

Parameter Name	Description
settlementId	settlement ID received in the Webhook 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	Settlement Id generated by PhonePe
`state`	String	Current State of the settlement ● INITIATED ● PROCESSED ● ATTEMPT_FAILED
`utr`	String	UTR reference of the settlement
`amount`	Long	Settlement Amount
`merchantId`	String	MID of the merchant for which the settlement is initiated.
`lastAttemptErrorCode`	String	Will be present only if the state is ATTEMPT_FAILED. – The Error Code for the failure
`lastAttemptErrorDescription`	String	Will be present only if the state is ATTEMPT_FAILED. – The Error description for the failure
`lastUpdatedAt`	DateTime	Epoch Timestamp of the last status updated (in milliseconds)