ody class="body-bg">

Settlement Webhook Reference

Introduction

Settlement Webhook: Our system will call your webhook url and post the settlement details once settlement is successful. To enable the settlement webhook you can enable from the dashboard, Settlement webhook is applicable to all products not specific to one product in the settlement webhook you will get product code to recognize the settlement belongs to which product. In case your webhook does not respond, our system marks the call as failed.

Your webhook should respond in JSON format with

  • content-type: application/json

Request

Parameters Datatype Description
settlementProduct string

Settlement product could be any of the below. It represents the settlement belongs to which product.

  • UPI
  • VIRTUAL_ACCOUNT
settlementDate string

Settlement date in ISO 8601 format

settlementId string

Unique Id generated by Paysharp to track every settlement.

settlementUTRNo string Unique transaction number provided by Bank for the settlement.
settlementAccountNo string Merchant's settlement bank account number. but due to privacy reason, first 4 digits and followed by asterisk will be returned.
settlementIFSCCode string Merchant's settlement bank account's IFSC code.
settlementMode string Settlement mode might be NEFT or RTGS.
settlementStatus string The settlement status always will be "SUCCESS" Paysharp send the settlement notification once receive settlement confirmation as success from the beneficiary bank.
settlementAmount number Amount settled for the settlement.
totalTransactions number Total number of transactions processed in the settlement. (In merchant dashboard, in settlement page able to view or download all the transactions processed for the settlement).
totalFee number Total fee charged for all the transactions settled in the settlement.
totalTax number Total tax charged for all the transactions settled in the settlement.
totalNetFee number Sum of both total fee and tax charged for all the transactions settled in the settlement.
attemptCount number Number of times the webhook invoked(Only returned for webhook response)

Response

This is the expected response from the merchant's webhook for the successful acknowledgement. HTTP response code should be 200 and response body in JSON format as mentioned below. In case Paysharp receives a different HTTP status code or response body, Paysharp system considers it as failure and retry webhook call based on retry configuration.

Parameters Datatype Description
code number

Merchant's webhook should always respond with 200 as code for successful acknowledgement

message string

Merchant's webhook should always respond with "success" as message for successful acknowledgement

Example

Two examples provided for two products, only "settlementProduct" value will be the difference

Example for UPI Settlement Case

{

   "settlementProduct" :   "UPI",

   "settlementDate" :   "2024-03-27T22:25:51+05:30",

   "settlementId" :   "STLMNTCL2YJ3yeS7bPbbpQbaWlfny7QX",

   "settlementAccountName" :   "ABC Solutions",

   "settlementAccountNo" :   "1102****",

   "settlementIFSCCode" :   "HDFC0000001",

   "settlementUTRNo" :   "N2020015167004",

   "settlementMode" :   "NEFT",

   "settlementStatus" :   "SUCCESS",

   "settlementAmount" :   199.65,

   "totalTransactions" :   3,

   "totalFee" :   4.50,

   "totalTax" :   0.81,

   "totalNetFee" :   5.31

   "attemptCount" :   1

}

Example for Virtual Account Settlement Case

{

   "settlementProduct" :   "VIRTUAL_ACCOUNT",

   "settlementDate" :   "2024-03-27T22:25:51+05:30",

   "settlementId" :   "STLMNTCL3YJ3yeS7bPbbpQbaWlfny7QX",

   "settlementAccountName" :   "ABC Solutions",

   "settlementAccountNo" :   "1102****",

   "settlementIFSCCode" :   "HDFC0000001",

   "settlementUTRNo" :   "N2020715167004",

   "settlementMode" :   "NEFT",

   "settlementStatus" :   "SUCCESS",

   "settlementAmount" :   199.65,

   "totalTransactions" :   3,

   "totalFee" :   4.50,

   "totalTax" :   0.81,

   "totalNetFee" :   5.31

   "attemptCount" :   1

}

Response

This is the exact JSON response expected from the merchant's webhook with HTTP status code as 200

    {  

"code" :   200,

"message" :   "success"

   }