JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Add Account

This api links the customer bank account to vpas (ONE_TO_MANY mapping). In case the vpa does not exist, same will be created.

If primaryAccountMapping is ONE_TO_ALL then account in request will be set primary for all vpas of a customer. If primaryAccountMapping is NONE then account in request will not be set primary for vpa passed in request.

Additionally, if setAsDefaultBank is passed as "true", then the account becomes default for the customer and all his vpas. All incoming payments to any of the customer vpas will be credited to this account.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/accounts/add

                      Content-Type
                      *
                      

string

Required

application/json

                      x-merchant-signature
                      *
                      

string

Required

This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.

                      x-merchant-id
                      *
                      

string

Required

Will be shared while onboarding.

                      x-merchant-channel-id
                      *
                      

string

Required

Will be shared while onboarding.

                      Accept
                      *
                      

string

Required

application/json

                      x-timestamp
                      *
                      

string

Required

This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.

Body

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer

Constraints : Alphanumeric string with dot(.). Maximum length is 256.

                      bankAccountUniqueId
                      *
                      

String

Mandatory

Unique id for the bank account to be linked

Constraints : bankAccountUniqueId in the response of Fetch Accounts api call.

                      customerVpa
                      *
                      

String

Mandatory

VPA to which the bank account should be linked

Constraints : something@handle

                      setDefault
                      *
                      

Boolean String

Mandatory

A flag denoting whether the account has to be made default for the customer

                      primaryAccountMapping
                      *
                      

String

Mandatory

A flag denoting whether the account has to be made primary for the customer

Constraints : ONE_TO_ONE, ONE_TO_ALL, NONE

                      udfParameters
                      
                      

Json String

optional

Stringified JSON for udf parameters

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API

Values : SUCCESS|FAILURE

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API

                      Payload
                      *
                      

JSON

Mandatory

                      merchantId
                      *
                      

String

Mandatory

Unique id for the merchant as passed in request headers

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the merchant channel as passed in request headers

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer as passed in the request

                      customerMobileNumber
                      *
                      

String

Mandatory

Customer mobile number

Values : 12 digits mobile number string

                      vpaAccounts
                      *
                      

Array of Json

Mandatory

Detail of all the active linked vpas and accounts

                      type
                      
                      

String

account

Type of the account

Values : NRO, SAVINGS, PPIWALLET, SOD, NRE, BANKWALLET, CURRENT, UOD

                      udfParameters
                      
                      

Json String

optional

Udf parameters as passed in the request

Constraints : JSON string

Have questions?
Need help? Contact support
LLM? Read llms.txt