search

POSTFunding/Disbursal Account List API

Use Case

This API is used to fetch the details (balance, guid) of funding account and all disbursal accounts.

 

HTTP Headers

ATTRIBUTE 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
optional

Sub wallet/disbursal account GUID. This is available on Paytm dashboard

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

Disbursal request status. It can be FAILURE or ACCEPTED or SUCCESS.

statusMessage
string

Description of each statusCode.

result
object

List of funding accounts / disbrusal accounts

Result
+
AttributeDescription
walletType
string(50)

This is the type of wallet which can be CORPORATE_VOUCHER or MARKETING_DEALS.

subWalletGuid
string(50)

Sub wallet/disbursal account GUID. This is available on Paytm dashboard

walletName
string(50)

This is the name of a wallet/disbursal account name.

walletBalance
string

Balance of the wallet/disbursal account.

currencyCode
string

Currency code

lastUpdatedDate
string

Last update date when the amount added in a wallet/disbursal account.

Response Codes & Messages

statusCodestatusstatusMessage
DE_001SUCCESSRequest Successfully fullfilled.
DE_1001FAILUREUnable to process the request, Please check and try again.
DE_1002FAILUREInvalid merchant.
DE_1003FAILURESub wallet not found.
DE_1006FAILUREMerchant is inactive.
DE_1007FAILUREWallet could not be found, please verify walletGuid.
DE_1009FAILURESub wallet guid is not associated with this merchant.
DE_1017FAILUREUnable to fetch subwallet of merchant.
Staging
Production
https://staging-dashboard.paytm.com/bpay/api/v1/account/listcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v1/account/list' \
--header 'Content-Type: application/json' \
--header 'x-mid: {mid}' \
--header 'x-checksum: {checksum}' \
--data '[]'
copy icon