Skip to main content
Phone Pe Business Logo

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.

EnvironmentHTTP MethodAPI
SandboxGEThttps://api-preprod.phonepe.com/apis/pg-sandbox/settlements/v1/{settlementId}/status
ProductionGEThttps://api.phonepe.com/apis/pg/settlements/v1/{settlementId}/status
Request Headers
Header NameHeader Value
Content-Typeapplication/json
AuthorizationO-Bearer <partner-auth-token>
X-MERCHANT-IDMID
Path Parameter
Parameter NameDescription
settlementIdsettlement ID received in the Webhook 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 NameTypeDescription
settlementIdStringUnique settlement ID generated by PhonePe.
stateStringCurrent status of the settlement. Possible values:
• INITIATED
• PROCESSED
• ATTEMPT_FAILED
utrStringUTR reference number associated with the settlement.
amountLongTotal amount settled.
merchantIdStringMerchant ID for whom the settlement has been initiated.
accountIdStringAccount ID associated with the merchant.
lastAttemptErrorCodeStringPresent only if the settlement state is ATTEMPT_FAILED. Indicates the error code of the failed attempt.
lastAttemptErrorDescriptionStringPresent only if the settlement state is ATTEMPT_FAILED. Provides the error description of the failed attempt.
lastUpdatedAtDateTimeTimestamp of the most recent update to the settlement status, in epoch (milliseconds)
Is this article helpful?