POSTAccount Passbook API

Use Case

This API provides the transactional level details and the closing balance per transaction. Merchants can use this API for their reconciliation needs.

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.

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

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 Date format YYYY-MM-DD
toDate string mandatory	Pass the end date Date format YYYY-MM-DD
startResult long optional	Start Result from which you want to fetch the records
endResult long optional	End result of the records

Response Attributes

Content Type : JSON

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

Result details and Number of Records

Result

Attribute

Description

resultSize

long

Number of records to fetch for this Page.

startResult

string

Start number from the total records

endResult

long

End number from the total records

result

object

Result Details

Result

Attribute	Description
merchantDisplayName string(50)	Merchant name
merchantId string(50)	Unique merchant identifier provided to every merchant by Paytm
creditOrDebit string(50)	Credit or Debit
txnAmount string	Amount
commission string	Commission amount
businessTxnType string	Business Transaction Type
tax string	Tax amount
tds string	Tds amount
txnId string	Wallet transaction id
merchantTxnType string	Disbursed to Food Wallet Disbursed to Gift Wallet Disbursed to Fuel Wallet Disbursed to User Wallet Disbursed to Communication Wallet Disbursed to Allowance Wallet Disbursed to Loyalty Wallet Funds Received Funds Added to Sub Account Funds Reclaimed from Sub Account Disbursed to Bank Refund From Bank
txnType string	Transaction type
txnStatus string	Txn status at wallet end
txnDate string	Date of transaction
orderId string	Merchant order id
paytmOrderID string	Paytm order id which is generated aginst the disbursal request.
mode string	This field contains disbursal mode like below Food Wallet Gift Wallet Fuel Wallet Wallet Communication Wallet Allowance Wallet Loyalty Wallet Paytm Points Bank Account - IMPS Bank Account - RTGS ValidationService - UPI ValidationService - Bank Account
purpose string	This field contains the purpose(like Salary Disbursement, Reimbursement, etc) for which disbursal made.
closingBalance string	Disbursal account closing balance
beneficiary string	Beneficiary account details
subWalletName string	Disbursal account name

Response Codes & Messages

resultCode	resultStatus	resultMsg
DE_001	SUCCESS	Success
DE_010	FAILURE	param is mandatory and it can't be null or blank
DE_400	FAILURE	Request Parameter Invalid
DE_401	FAILURE	Authentication Parameters Required
DE_402	FAILURE	Access Denied
DE_404	FAILURE	Unable to authenticate the request
DE_405	FAILURE	Remote IP not whitelisted
DE_406	FAILURE	Invalid Client-Token
DE_407	FAILURE	Checksum Required
DE_408	FAILURE	Checksum Required
DE_409	FAILURE	Checksum Verification Failed
DE_410	FAILURE	Method Not Supported

⇾

Staging

Production

https://staging-dashboard.paytm.com/bpay/api/v1/account/statement copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v1/account/statement' \
--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"}'