POSTSettlement Summary API
Use Case
Settlement Summary API retrieves the overall summary details of a payout corresponding to a single date or date range or payout ID. Merchant can get a summarised view of total settled amount to his bank account. This API also includes total payment amount/count, refund amount/count, chargeback amount/count etc.
Note: This API can be used only on production environment.
Merchant Authentication
For Authentication, JWT tokenization is used, please click here for more details.
Request Attributes
Head
| ATTRIBUTE | DESCRIPTION |
|---|---|
| reqMsgId mandatory |
The request message id Example : 9b688fce-c59f-4ead-9677-c38a43e3ab59 Note: For creating reqMsgId, please refer this link. |
Body
Payout Summary Based on Payout Date
| ATTRIBUTE | DESCRIPTION |
|---|---|
| mid mandatory |
Unique merchantId Example. HelloM8xxxxxxxx45 |
| startDate mandatory |
Date from which merchant wants to check the settlement data. Example. 2022-07-06 |
| endDate |
Date upto which merchant wants to check the settlement data Note: Maximum Date Range between Start and End date supported is 1 weekExample. 2022-07-06T00:00:00+05:30 |
| pageNum mandatory |
Current page number Example. 1 |
| pageSize mandatory |
the size of one page Note : Maximum Page Size is 50 Example. 20 |
Payout Summary Based on Payout ID
| mid mandatory |
Unique merchantId Example. HelloM8xxxxxxxx45 |
| payoutId mandatory |
Payout ID for the bank transfer made. Example. ALL2xxxxxxxxxxxxxxx911 |
| pageNum mandatory |
Current page number Example. 1 |
| pageSize mandatory |
the size of one page Note : Maximum Page Size is 50 Example. 20 |
Response Attributes
Head
| ATTRIBUTE | DESCRIPTION |
|---|---|
| reqMsgId | The request message id Example : 9b688fce-c59f-4ead-9677-c38a43e3ab59 |
| respTime | Time at which response is being sent Example : 2022-09-09T11:20:52+05:30 |
Body
| ATTRIBUTE | DESCRIPTION |
|---|---|
| mid | Unique merchantId Example. HelloM8xxxxxxxx45 |
| payoutId | Payout ID for the bank transfer made Example. ALL2xxxxxxxxxxxxxxx911 |
| payoutDate | Date on which payout is generated Example 2022-07-06T00:00:00+05:30 |
| settlementDate | Date on which settlement has happened Example. 2022-07-06T04:38:46+05:30 |
| releaseStatus | PAYOUT_SETTLED', 'PAYOUT_UNSETTLED' Example. PAYOUT_SETTLED |
| payOutAmount | Total Amount Settled to the mentioned MID Example. 4.00 |
| paymentAmount | Total Transacted Amount Example. 4.00 |
| paymentCount | Total count of acquiring transactions |
| refundAmount | Total Refund Amount in case of refund transactions |
| refundCount | Total Count of Refund transactions |
| refundMerchantCommission | Commission charged on refund transactions |
| refundServiceTax | Service Tax charged on refund transactions |
| chargebackAmount | Total Chargeback amount |
| chargebackCount | Total Count of chargeback transactions |
| cancelAmount | Total Cancel Amount |
| cancelCount | Total Count of cancel transactions |
| cancelMerchantCommission | Commission charged on cancelled transactions |
| cancelServiceTax | Service Tax charged on cancelled transactions |
| repaymentAmount | Total Repayment Amount |
| repaymentCount | Total Count of Repayment transactions |
| commission | Commission charged for transaction |
| serviceTax | Service tax charged for transaction |
| utr | Unique Transfer Reference Number for a bank transfer Example. 21xxxxxxxx04 |
| settlementAccountNo | Account No. to which the settlement amount is transferred |
| settlementBankName | Name of the bank in which settlement is done |
| settlementBankIFSC | IFSC Code of bank to which settlement amount is transferred |
Response Codes & Messages
| resultCode | resultStatus | resultMsg |
|---|---|---|
| 00000000 | SUCCESS | success |
| 00000004 | PARAM_ILLEGAL | parameter illegal |
| 00000900 | SYSTEM_ERROR | unknown system error |
| 12014163 | INTERNAL_ID_NOT_EXIST | Platform internal id is not exist |
| 12014162 | OVER_MAX_QUERY_TIME | Support max query time is 180 days |
| 00000019 | PROCESS_FAIL | Process fail |
| 10010007 | NO_RECORDS_FOUND | No records found |
Staging
Production
This API is not hosted on staging environment.
REQUEST
RESPONSE
CURL
CURL
curl --location --request POST 'https://securegw.paytm.in/merchant-settlement/SettlementSummary' \
--header 'Content-Type: application/json' \
--header 'clientId: xxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxx' \
--data-raw '{
"request": {
"head": {
"reqMsgId": "9b688fce-c59f-4ead-9677-c38a43e3ab59"
},
"body": {
"mid": "HelloM8xxxxxxxx45",
"startDate": "2022-07-06",
"pageNum": 1,
"pageSize": 10
}
}
}'
