Body
Fetch Customer 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
application/json
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
*
integer
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.
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
String
Optional
Stringified JSON for udf parameters
accountType
*
String
Mandatory
Account Type(In CC TPAP should send accountType as CREDIT, in other cases they can skip sending this field)
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
json
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
String
optional
Bank accounts as returned by NPCI for the customer mobile number
Values:Array of accounts
vpaSuggestions
String
optional
Vpa suggestions for the bank accounts fetched
Values:Array of strings
udfParameters
json String
optional
Udf parameters as passed in the request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt