Settlement Webhooks

The webhook will be sent if the settlement is Initiated, Processed and Attempt Failed.

Sample Response

Copied !


{
    "event" : "settlement.initiated",
    "payload": {
        "settlementId" : "abca-defa-kadi-dald",
        "state" : INITIATED,
        "utr" : "UTR100291",
        "amount" : 100,
        "merchantId" : "merchantId",
       "lastAttemptErrorCode": "",
       "lastAttemptErrorDescription" : "",
        "lastUpdatedAt" : 121211331
    }
}

Response Parameters

Parameter Name	Type	Description
`event`	String	The Webhook event type. Possible Values: ● settlement.initiated ● settlement.processed ● settlement.attempt.failed
`payload`	Object	The settlement related details
`payload`.`settlementId`	String	Settlement Id generated by PhonePe
`payload.state`	String	Current State of the settlement ● INITIATED ● PROCESSED ● ATTEMPT_FAILED
`payload.utr`	String	UTR reference of the settlement
`payload.amount`	Long	Settlement Amount
`payload.merchantId`	String	MID of the merchant for which the settlement is initiated.
`payload.lastAttemptErrorCode`	String	Will be present only if the state is ATTEMPT_FAILED. – The Error Code for the failure
`payload.lastAttemptErrorDescription`	String	Will be present only if the state is ATTEMPT_FAILED. – The Error message for the failure
`payload.lastUpdatedAt`	DateTime	Epoch Timestamp of the last status updated (in milliseconds)

Sample Response

Response Parameters

Updated on Aug 08, 2024