Extras

This document describes additional (optional) APIs that the merchant can use.

Get the credit info of the user#

This API end-point can be used to fetch the credit information of the user.

API Definition#

Request
Response

POST https://sdk.bharatx.tech/service/payments/merchant/user/credit/info?userPhoneNumber=%2B919999999999
Headers:Authorization: Basic abcde=

userPhoneNumber: the phone number of the user with country code

Headers:Content-Type: application/json
Body:{  "registrationStatus": "string",  "creditLimit": 0,  "creditTaken": 0,  "paymentLink":"string",  "upcomingDueDate":"20/01/2022",  "outstandingAmount": 0,  "dueAmount": 0}

registrationStatus: Can be either of registered or unregistered. If the user is unregistered then other field will have their default values and should be ignored.
creditLimit: The credit limit available to the user in paise. If the user is not approved via BharatX, this field will be 0 and other field will have default values.
creditTaken: The credit limit used by the user for the current cycle.
paymentLink: The payment link for the particular user. The merchant can redirect the user to this link whenever user wants to make a payment.
upcomingDueDate: The next due date for the user.
outstandingAmount: The total outstanding amount the user owes BharatX
dueAmount: The pending due amount of the user.

Push identification data of the user#

This API end-point can be used to push the identification information for the user.

API Definition#

Request
Response

POST https://sdk.bharatx.tech/service/database/merchant/user/feed/identification
Headers:Authorization: Basic abcde=Content-Type: application/json 
Body:{  "userPhoneNumber":"+919999999999",  "identification": {    "aadharNumber":"1111222233334444",    "panNumber":"ABCD1234E"  }}

userPhoneNumber: the phone number of the user with country code
identification.aadharNumber: aadhar number of the user
identification.panNumber: pan number of the user

Headers:Content-Type: application/json
Body:{  "message": "ok"}

Push generic data of the user#

This API end-point can be used to push the generic information about the user.

API Definition#

Request
Response

POST https://sdk.bharatx.tech/service/database/merchant/user/feed/merchant-data
Headers:Authorization: Basic abcde=Content-Type: application/json 
Body:{  "userPhoneNumber":"+919999999999",  "data": JSON}

userPhoneNumber: the phone number of the user with country code
data: json object or array

Headers:Content-Type: application/json
Body:{  "message": "ok"}