Body
Fetch Accounts
This api fetches customer accounts from NPCI. accounts will be present in the response only if gatewayResponseCode = "00". In case there are one or more accounts fetched, vpaSuggestions will be sent in response.
Note
In case merchant retries this api, the accounts will be fetched from NPCI again.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/accounts/fetch
Headers
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.
Parameters
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints : Alphanumeric string with dot(.). Maximum length is 256.
upiRequestId
*
String
Mandatory
Unique id sent to UPI switch for the request
Constraints : 35 character alphanumeric. Should always start with merchant prefix provided.
deviceFingerPrint
*
String
Mandatory
Device fingerprint of the customer
bankCode
*
String
Mandatory
Bank code (IIN) of selected bank
udfParameters
JSON String
optional
Stringified JSON for udf parameters
accountType
String
Conditional
Account Type = CREDIT. This parameter is required to use UPI on Credit Card Feature
Account Type = UPICREDIT. This parameter is required to use UPI on Credit Line Feature
aadhaarConsent
String
Conditional
Consent from the customer to onboard using Aadhaar. This parameter is required to use Aadhaar OTP onboarding
200 : Success
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
Mobile number of the customer
Values : 12 digits mobile number string
gatewayTransactionId
*
String
Mandatory
Transaction id returned by gateway
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values : SUCCESS|FAILURE
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway
accounts
Array of JSON
optional
Bank accounts as returned by NPCI for the customer mobile number
bankCode
String
bankName
String
maskedAccountNumber
String
mpinLength
String
mpinSet
Boolean String
otpLength
String
atmPinLength
String
bankAccountUniqueId
String
ifsc
String
name
String
type
String
Note
General → SAVINGS/CURRENT
OD/Credit Line → CREDITLINE, CREDITLINE01, CREDITLINE02, CREDITLINE03, CREDITLINE04, CREDITLINE05, CREDITLINE06, CREDITLINE07, CREDITLINE08, CREDITLINE09, CREDITLINE10, CL01, CL011, CL012, CL013, CL014, CL015, CL02, CL03, CL04, CL05, CL06, CL07, CL08, CL09, CL10
allowedMCC
String
Conditional
notallowedMCC
String
Conditional
accSubType
String
Conditional
vpaSuggestions
Array of Strings
optional
Vpa suggestions for the bank accounts fetched
isAadhaarNumberAvailable
Boolean String
optional
Customer Aadhaar number is received or not
aadhaarEnabled
*
Boolean String
Mandatory
Customer account is Aadhaar Enabled or not
udfParameters
JSON String
optional
Udf parameters as passed in the request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt