Body
Add Primary Account
This api is used to change primary account of vpas of customer. The account passed in the api will become primary for the vpa in request body. If vpa is not passed, the account will become primary for all the vpa's of customer.
Note
This is an idempotent api.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{{uri}}/merchants/vpaAccounts
Headers
x-merchant-id
*
string
Required
Will be shared while onboarding.
x-merchant-channel-id
*
string
Required
Will be shared while onboarding.
x-timestamp
*
string
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
x-merchant-signature
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
content-type
*
String
Required
application/json
accept
*
String
Required
application/json
Request Schema: application/json
Parameters
merchantCustomerId
*
String
Mandatory
Description: Merchant generated unique profile id for customer
Constraints: Alphanumeric string with dot(.). Maximum length is 256.
action
*
String
Mandatory
Description: Action to be performed on vpaAccounts
Constraints: PRIMARY_ACCOUNT
bankAccountUniqueId
*
String
Mandatory
Description: Unique id for the bank account to be linked
Constraints: bankAccountUniqueId in the response of Fetch Accounts api call.
customerVpa
String
Optional
Description: Vpa to which the bank account should be linked as primary account
Constraints: something@handle
udfParameters
JSON String
Optional
Description: Stringified JSON for udf parameters
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values: SUCCESS, FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
Values:Refer error code section
responseMessage
*
String
Mandatory
PSP response message for the API
Values:Refer error code section
payload
*
String
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
vpas
*
Array of String
Mandatory
List of vpas added
accounts
*
Array of String
Mandatory
List of accounts
defaultBankAccountUniqueId
*
String
Mandatory
Unique id for the default bank account of the customer
udfParameters
JSON String
Optional
Udf Parameters as passed in the request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt