Skip to main content

User Registration

Users need to be registered before creating any transactions. Otherwise, the transactions so created will automatically fail.

Check the registration status of the user#

This API end-point can be used to see if the user is registered for the UPI Credit service.

API Definition#

GET https://sdk.bharatx.tech/service/payments/merchant/user/registration/status?userPhoneNumber=%2B9999999999
Headers:Authorization: Basic abcde=

Request an OTP#

If the previous API returned otp for nextStep field, then the merchant can call this API to trigger an OTP for the user.

API Definition#

POST https://sdk.bharatx.tech/service/payments/merchant/user/registration/otp/request
Headers:Authorization: Basic abcde=Content-Type: application/json
Body:{  "userPhoneNumber":"+919999999999",  "userFirstName":"string",  "userLastName":"string"}
  • userPhoneNumber is required
  • userFirstName is required
  • userLastName is optional

OTP Validation#

Once the user receives the OTP, user will pass it on to the merchant via the merchant app. The merchant can then call this API to validate the OTP received from the user and complete the registrtation process.

API Definition#

POST https://sdk.bharatx.tech/service/payments/merchant/user/registration/otp/verify
Headers:Authorization: Basic abcde=Content-Type: application/json
Body:{  "userPhoneNumber":"+919999999999",  "otpToken":"abcde",  "otpValue":"123456"}
  • otpToken: This is the token received in the previous API.
  • otpValue: The OTP value entered by the user. We supply 6-digit OTP codes as of now.