POSTSplit Settlement API
Use Case
The split settlement is a new interface that will provide the functionality to retrieve the vendor/child level data when the vendor Id is passed in the request.
Request Attributes
| Attribute | Description | |
|---|---|---|
| merchantId string(64) |
Unique merchantId that paytm provides to each merchant Example: INTEGR7769XXXXXX9383 Note: more than 64 will give bad request |
|
| vendorId string(64) |
||
| utrProcessedStartTime string mandatory |
Date from which merchant wants to check the settlement data. Data will be available for last 6 months of the current date Example: 2021-04-27 |
|
| utrProcessedEndTime string optional |
Date to which merchant wants to check the settlement data. Data will be available for last 6 months of the current date. Example: 2021-04-28 Note: If not provided, API will pick this value as utrProcessedStartTime + 1 |
|
| checksumHash string mandatory |
Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request. |
|
| pageNum integer mandatory |
Offset of records to show (Default: 1) Example: 1 |
|
| pageSize integer mandatory |
Max entry count in a page, max value is 50 Example: 20 |
Response Attributes
| Attribute | Description |
|---|---|
| status Enum RestStatus |
This parameter indicates the status of API call. Possible values: SUCCESS, FAILURE, RECORD_NOT_FOUND |
| count integer |
Count Example: 10 |
| resultCode string |
This is the resultCode corresponding to a particular message and is returned to the merchant. Its maximum length is 64. Example: 00000000 |
| errorMessage string |
Error Message Example: CHECKSUM_VALIDATION_FAILED |
| totalCount integer |
Count of transactions/refunds included in the settlement on the chosen day Example: 1 |
| settlementDetailList list |
The list of detailed settlements. |
| pageNum integer |
Current page no Example: 1 |
| pageSize integer |
No. of transaction records on the current page Example: 20 |
| totalPages integer |
Total number of pages that contain transaction level data for that date |
| totalTransactions integer |
Total count of transactions Example: 4 |
Response Codes & Messages
| resultCode | resultStatus | resultMsg |
|---|---|---|
| 00000000 | SUCCESS | SUCCESS |
| 00000075 | FAILURE | Vendor is not assigned under this Merchant |
| 00000022 | FAILURE | CHECKSUM_VALIDATION_FAILED |
| 00000030 | FAILURE | ILLEGAL_PARAM |
| 00000031 | FAILURE | Internal Server Error |
| 00000076 | FAILURE | Internal Server Error |
Staging
Production
This API is not hosted on staging environment.
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securegw.paytm.in/merchant-settlement-service/settlement/list/v2' \
--header 'Content-Type: application/json' \
--data '{"merchantId": "xxxxxxxxxxxxxxxxxxxxx","vendorId":"iXXwgInvXXXXXX105","pageNum":1,"pageSize":10, "utrProcessedStartTime": "2022-01-10","utrProcessedEndTime": "2022-01-12", "checksumHash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}'
