JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Fetch Customer Info

This api returns the registration and account information maintained at the PSP for the customer. Merchants can use this api to periodically sync data with the PSP.

This api is idempotent.
Use the vpas with only its respective primaryBankAccountUniqueId returned in response in case of one vpa to one account mapping.
Use any possible combination of vpas and accounts returned in response in case of all vpa to all account mapping
Add --header 'x-api-version: 1' to get UpiNumbers linked with the merchantCustomer.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{{uri}}/merchants/vpaAccounts

                      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
                      *
                      

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.

Body

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer
Constraints: Alphanumeric string with dot(.). Maximum length is 256.

                      action
                      *
                      

String

Mandatory

Action to be performed
Value : CUSTOMER_INFO

                      udfParameters
                      
                      

JSON String

Optional

Stringified JSON for udf parameters

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

Customer mobile number as per device binding
Values: 12 digits mobile number string

                      vpas
                      *
                      

Array of json

Mandatory

List of linked vpas

vpa

String

                      primaryBankAccountUniqueId
                      
                      

String

                      accounts
                      *
                      

Array of Json

Mandatory

List of accounts

                      maskedAccountNumber
                      
                      

String

                      otpLength
                      
                      

String

                      mpinSet
                      
                      

String

                      atmPinLength
                      
                      

String

                      name
                      
                      

String

                      ifsc
                      
                      

String

                      type
                      
                      

String

                      bankCode
                      
                      

String

                      mpinLength
                      
                      

String

                      bankAccountUniqueId
                      
                      

String

                      bankName
                      
                      

String

                      defaultBankAccountUniqueId
                      *
                      

String

Mandatory

Unique id for the default bank account of the customer

                      deviceDetails
                      *
                      

Json Object

Mandatory

Device related details of the customer

                      deviceFingerPrint
                      
                      

String

                      deviceId
                      
                      

String

                      manufacturer
                      
                      

String

                      model
                      
                      

String

                      version
                      
                      

String

os

String

                      ssid
                      
                      

String

                      packageName
                      
                      

String

                      upiNumbers
                      
                      

Array of Json

Optional

Data about all the upiNumbers, linked vpa, status and expiry if status is DELETED

                      udfParameters
                      
                      

JSON String

Optional

Udf parameters as passed in the request

Have questions?
Need help? Contact support
LLM? Read llms.txt