POSTOrder List Report API
Use Case
This API can be used by the merchant to fetch order level details of a given sub-wallet for the respective time period.
HTTP Headers
PARAMETER | DESCRIPTION |
---|---|
x-mid string(50) |
Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation. |
x-checksum string(108) |
Signature encryption for validation. It's value to be sent should be the checksum string created by using Paytm checksum library. Note: Create the signature using all the request parameters. |
Request Attributes
Body
Attribute | Description |
---|---|
subwalletGuid string mandatory | Sub wallet/disbursal account GUID. This is available on Paytm dashboard |
fromDate string mandatory | Pass the from date from which txns need to fetch |
toDate string mandatory | Pass the end date |
pageSize long optional | Number of records to fetch for this Page |
pageNumber long optional | Offset of records to show (Default: 1) |
txnType string mandatory | Transaction Type of the records to fetch, values- DISBURSE_TO_BANK : All the orders disbursed to Bank |
Response Attributes
Body
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
statusCode string | Failure reason code where status is FAILURE. A detailed list of statusCode is mentioned at the bottom of this page. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status string(30) | It can be SUCCESS or FAILURE | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statusMessage string | Description of each statusCode. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result object | List of funding accounts / disbrusal accounts | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Result +
|
Response Codes & Messages
statusCode | status | statusMessage |
---|---|---|
DE_001 | SUCCESS | Success |
DE_400 | FAILURE | Request Parameter Invalid |
DE_401 | FAILURE | Authentication Parameters Required |
DE_402 | FAILURE | Access Denied |
DE_403 | FAILURE | API Not Found |
DE_404 | FAILURE | Unable to authenticate the request |
DE_405 | FAILURE | Remote IP not whitelisted |
DE_406 | FAILURE | Invalid Client-Token |
DE_407 | FAILURE | Client-Token Required |
DE_408 | FAILURE | Checksum Required |
DE_409 | FAILURE | Checksum Verification Failed |
DE_410 | FAILURE | Method Not Supported |
DE_411 | FAILURE | Media-Type Not Supported |
curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v2/report' \
--header 'Content-Type: application/json' \
--header 'x-mid: {mid}' \
--header 'x-checksum: {checksum}' \
--data '{"subwalletGuid":"28054249-XXXX-XXXX-af8f-fa163e429e83","fromDate":"2020-01-20","toDate":"2020-02-20"}'