Onboarding API

Request Method :: POST
Description:This API would be a set of programmable interfaces provided by a Payment Service Provider (PSP) or bank that allows businesses or other third-party applications to programmatically initiate and manage their onboarding process for accessing UPI payment functionalities.
Staging Base URL:https://api-stage.txninfra.com/apiEncrStage/isu/
API Endpoint:/apiAgentOnboarding/externalonboard

Headers

Content-Type: application/JSON
header_secrets: To be provided by the ISU Team during integration.
pass_key: To be provided by the ISU Team during integration.

Request Body Parameters

Parameters Description Sample Data Type Mandatory/ Optional
productType Product type upi_api string Mandatory
address Address KIRTI NAGAR DELHI string Mandatory
area Area KIRTI NAGAR DELHI string Mandatory
bcagentid BC Agent ID. The User name. ramlal9 string Mandatory
bcagentname First name of the BC Agent Nikhil string Mandatory
companyname Company name RNFI relipay string Mandatory
email Email Id of the User [email protected] string Mandatory
lastname Last Name of the BC Agent. ISERVUE string Mandatory
mobilenumber Mobile Number 8539061121 string Mandatory
pancard PAN Number BETLI2408P string Optional
pincode PIN code of the Address 110015 integer Mandatory
shopaddress Shop Address KIRTI NAGAR DELHI string Mandatory
shoparea Area where the shop is located KIRTI NAGAR DELHI string Mandatory
shopcity City where the shop is located. Delhi string Mandatory
shopdistrict District where the shop is located. KIRTI NAGAR string Mandatory
shopname Registered name of the shop RNFI relipay string Mandatory
shoppincode PIN code of the shop 110015 Integer Mandatory
shopstate State where the shop is located. DELHI string Mandatory
AADHAAR Aadhar number 678965467890 string Optional
lat Latitude of Location. 123456 string Optional
long Longitude of Location. 123123123 string Optional
ifsc IFSC Code string SBIN0014471 Optional
isApiRetailer Is API Retailer or not. Boolean true Optional
bankName Name of the bank State bank of India string Optional
accountNumber Account Number 09876546890 string Optional
vpa VPA vpaTest17 string Optional
mid Mid code sdd123 string Optional
qr_string QR String   string Optional

Sample Request Body

Sample Request Body(Encrypted)

Response Body Parameters

Parameters Parameter description Data type
status Overall Status of the Operation string
statusCode Status Code for the operation string
statusDesc Status Description of the operation string
data Fetched data object
status Status of the performed operation string
message Message describing the operation string
results Results string
success Success operation details (for Success Responses) array
merchant_id Merchant ID string
message Message describing the onboarding operation. string
failed Failed operation details (for Failed Responses) string

Sample Response Body

SUCCESS:

Sample Response (Encrypted)

Sample Error Response:

Status Details

Status Message
0 UPI_API Onboarded successfully
1 ERRDU01:- Duplicate user

Detailed Error Codes and Description

Error Codes Error Description
ERRPIN01 Does not get pinDetails Data
ERRPIN02 Does not get pinDetails Data
ERRSWT01 Something went to wrong
ERRBAS11 Something went to wrong
ERRFAD01 Admin not Onboaded
ERRDU01 Duplicate user Name
ERRCPM01 Duplicate Mobile Number
ERRCPM01 Duplicate Pan Number(not for upi-api)
ERRCPM05 Duplicate MID only for upi-api
ERRIDN01 Data not Insert into DB
ERRIDN02 Data not Insert into DB