search

POSTOrder List Report API

Use Case

This API can be used by the merchant to fetch the order level details for a given sub-wallet for a respective date range

 

HTTP Headers

PARAMETER DESCRIPTION

x-mid

string(50)
mandatory

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)
mandatory

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

Content Type : JSON

Body

AttributeDescription
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
Date format YYYY-MM-DD

toDate
string
mandatory

Pass the end date
Date format YYYY-MM-DD

pageSize
long
optional

Number of records to fetch for this Page
(Default: 100)

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

Content Type : JSON

Body

AttributeDescription
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
+
AttributeDescription
pageNumber
string(30)

Offset of records to show (Default: 1)

pageSize
string(30)

Number of records to fetch for this Page (Default: 100)

orders
object

Order List

Orders
+
AttributeDescription
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.

Example: INTEGR7769XXXXXX9383

merchantName
string

Name of the merchant entity

subwalletName
string

Disbursal account name

merchantOrderId
string(50)

Unique reference id provided by the merchant for this disbursal request

paytmOrderId
string(50)

Unique ID generated at paytm end corresponding to each transaction

disburseDate
string

Disbursement date

amount
string

Amount in INR requested by the merchant for disbursal

commissionAmount
string

Commission amount in INR payable by the merchant. This will contain digits up to two decimal points

tax
string

Tax amount in INR payable by the merchant. This will contain digits up to two decimal points

rrn
string(10)

Unique reference number created by a bank against each transaction.

payMode
string

Type of transaction

payModeValue
string

Beneficiary account details

payModeMeta
object

Contains meta data

payModeMeta
+
AttributeDescription
ifscCode
string

IFSC Code

walletTxnId
string

Unique txn no generated at wallet end

status
string

Status of the disbursal order

statusCode
string

Code of the FAILURE message

statusMsg
string

Status code description

purpose
string

Disbursement purpose

comments
string

Txn comment

subwalletGuid
string

Disbursal account GUID

beneficiaryName
string

Beneficiary name

transferMode
string

Transfer mode can be IMPS, NEFT, UPI

Response Codes & Messages

statusCodestatusstatusMessage
DE_001SUCCESSSuccess
DE_400FAILURERequest Parameter Invalid
DE_401FAILUREAuthentication Parameters Required
DE_402FAILUREAccess Denied
DE_403FAILUREAPI Not Found
DE_404FAILUREUnable to authenticate the request
DE_405FAILURERemote IP not whitelisted
DE_406FAILUREInvalid Client-Token
DE_407FAILUREClient-Token Required
DE_408FAILUREChecksum Required
DE_409FAILUREChecksum Verification Failed
DE_410FAILUREMethod Not Supported
DE_411FAILUREMedia-Type Not Supported
Staging
Production
https://staging-dashboard.paytm.com/bpay/api/v2/reportcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
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"}'
copy icon