Body
Link VPA Account
This api is used to add vpa or account and manage the linking between them. The api takes an account and optionally a vpa. Account is added and if vpa is passed in request, vpa is created for the customer. The linking between the vpa and account is managed based on the values passed in flags array.
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: LINK_VPA_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
flags
Array of String
Optional
Description: flags to make decisions for various vpa and account linking options
Values: SetAccountAsPrimaryForVpa | SetAccountAsPrimaryForAllVpas | SetAccountAsDefault | DeleteLinkedVpas
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 Json
Mandatory
List of vpas added
vpa
String
primaryBankAccountUniqueId
String
accounts
*
Array of Json
Mandatory
List of accounts
maskedAccountNumber
String
otpLength
String
mpinSet
Boolean String
atmPinLength
String
ifsc
String
name
String
type
String
bankCode
String
mpinLength
String
bankAccountUniqueId
String
bankName
String
defaultBankAccountUniqueId
*
String
Mandatory
Unique id for the default bank account of the customer
type
String
Optional
Type of the account
Values - NRO, SAVINGS, PPIWALLET, SOD, NRE, BANKWALLET, CURRENT, UOD
upiNumbers
Array Of Json
Optional
Data about all the upiNumbers, linked vpa, status and expiry if status is DELETED
expiry
String
upiNumber
String
upiNumberStatus
String
vpa
String
deviceDetails
Array Of Json
Optional
This returns the device-details provided during bind device api call.
deviceFingerPrint
String
deviceId
String
manufacturer
String
model
String
version
String
os
String
ssid
String
packageName
String
udfParameters
JSON String
Optional
Udf Parameters as passed in the request