search

POSTCreate Disbursal Account

Use Case

This API is used to create a sub wallet for the merchant.

 

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 the Paytm checksum library.
Note: Create the signature using all the request parameters.

Request Attributes

API Content Type: JSON

ATTRIBUTE DESCRIPTION

walletName

string
mandatory

Unique name for each sub wallet and the two sub wallets cannot have the same name. The max no. of characters allowed is 30.

For example: "ggtest12"

purpose

string
optional

Purpose of creating the sub wallet

vanRequired

boolean
optional

Create a unique Virtual Account Number for each sub wallet. Virtual A/C no will be generated only if the MID has permission to create a VAN.

Possible Values: true, false

Response Attributes

API Content Type: JSON

ATTRIBUTE DESCRIPTION

statusCode

string

It should be used to fetch the sub wallet creation Status.

Possible Values: SUCCESS, FAILURE

status

string

It gives the exact error code for all the responses. A complete list of StatusCode is mentioned in the Response Codes section.

statusMessage

string

Description of each statusCode.

result

object

Result
Detailed response result
 

Result

ATTRIBUTE DESCRIPTION

subWalletGuid

string

GUID to be saved to use for future disbursals

Example: "7XXXXfeX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

subWalletName

string

Unique name for each sub wallet

Example: gXXXX1X

subWalletVan

string

Account number & IFSC Code to be shared with a partner to deposit money

Example: 3XXXXXXXXXXX

subWalletIfscCode

string

Ifsc code of the bank account associated with the sub wallet

Example: PYTM0XXXXXX

Response Codes & Messages

statusCodestatusstatusMessage
DE_1250FAILURESub wallet VAN cannot be created on your account. Please mark the create sub wallet VAN value as False and reinitiate the request
DE_1251FAILURESub wallet could not be created
DE_1252FAILURESub wallet created but Van could not be generated
DE_1253FAILURESub wallet with the same name already exists
Staging
Production
https://staging-dashboard.paytm.com/bpay/api/v1/account/createcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://staging-dashboard.paytm.com/bpay/api/v1/account/create' \
--header 'Content-Type: application/json' \
--header 'x-mid: {mid}' \
--header 'x-checksum: {checksum}' \
--data'{"walletName":"abc","purpose":"abc","vanRequired":"false"}'
copy icon