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 retires 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
The type of content of request
x-merchant-id
*
string
Required
provided at time of onboarding
x-merchant-channel-id
*
string
Required
provided at time of onboarding
Accept
*
string
Required
The type of content of response
x-timestamp
*
integer
Required
timestamp of the request
x-merchant-checksum
*
string
Required
checksum calculated for the request body
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
aadhaarConsent
Aadhaar Consent to fetch Customer Aadhaar Details
udfParameters
String
optional
Stringified JSON for udf parameters
Have questions?
- Need help? Contact support
- LLM? Read llms.txt