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.

You can 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/customer/info

                      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.

                      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

                      deviceDetails
                      *
                      

Mandatory

Json

                      deviceFingerPrint
                      *
                      

String

Mandatory

Fingerprint of the customer device

                      deviceId
                      *
                      

String

Mandatory

Unique identifier for the customer device

                      manufacturer
                      *
                      

String

Mandatory

Manufacturer of the customer device

                      model
                      *
                      

String

Mandatory

Model of the customer device

                      version
                      *
                      

String

Mandatory

Version of the operating system on the customer device

                      os
                      *
                      

String

Mandatory

Operating system running on the customer device

                      ssid
                      *
                      

String

Mandatory

Identifier of the SIM used to send the SMS

                      packageName
                      *
                      

String

Mandatory

Package name of the UPI application

                      vpaAccounts
                      *
                      

Array of Json

Mandatory

Vpa account mapping of the customer
Values: Array of vpa accounts

                      udfParameters
                      
                      

JSON String

Optional

Udf parameters as passed in the request

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