Onboarding API

Request Method :: POST
Description:This document provides guidelines and technical instructions for integrating applications with the Unified Payments Interface (UPI) platform through APIs. It outlines the onboarding process, and configuration steps necessary for partners or merchants to successfully connect with the UPI system.
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

Parameter Name Example Validation Rule Data Type Mandatory/ Optional
productType upi-api Always pass upi-api string Mandatory
bcagentid Iserveu12 Minimum 5 and maximum 100 string Mandatory
bcagentname ram Minimum 3 and maximum 49 string Mandatory
middlename kumar optional string optional
lastname dash Minimum 3 and maximum 49 string Mandatory
companyname RNFI relipay Minimum 5 and maximum 100 string Mandatory
address Patia,bhubaneswara Minimum 5 and maximum 200 string Mandatory
area Patia Minimum 5 and maximum 30 string Mandatory
email [email protected] Minimum 3 and maximum 49 string Mandatory
mobilenumber 7654324578 10 digits string Mandatory
pancard DFEOO9988R 10 alphaneumeric string Optional
pincode 750123 6 digit numeric number Mandatory
shopaddress KIRTI NAGAR DELHI Minimum 5 and maximum 200 string Mandatory
shoparea KIRTI NAGAR DELHI Minimum 5 and maximum 30 string Mandatory
shopcity Delhi Minimum 3 and maximum 50 string Mandatory
shopdistrict KIRTI NAGAR Minimum 5 and maximum 50 string Mandatory
shopname RNFI relipay Minimum 5 and maximum 50 string Mandatory
shoppincode 764509 6 digit numeric string Mandatory
shopstate DELHI Minimum 3 and maximum 50 string Mandatory
AADHAAR 765467654874 string Optional
ifsc SBIN0014475 String Optional
accountNumber 09876546890 string Optional
isApiRetailer Is API Retailer or not. String Optional
bankName State bank of India string Optional
lat 12.34 string Optional
long 34.43 string Optional
mid testvpa@bank alphanumeric string Mandatory
vpa testvpa@bank string Optional
qr_string Pass proper qr string string Mandatory
branch_code branch_006 string Optional
Default_language English string Optional
Sim_provider JIO string Optional
param_c To be used as per the requirement string Optional
Is_repeat Indicates whether the request or transaction is a repeated attempt. YES/NO string Optional

Sample Request Body

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
bcagentid Unique identifier assigned to the BC agent for UPI API onboarding. string
data Fetched data object
status Status of the performed operation string
message Message describing the operation string
statusDesc Detailed description of the onboarding status. string
data Additional response data related to the onboarding process (if available). String
qr_string Unique QR string generated for the device or merchant, used for processing UPI payment transactions. string
updated_date Date and time when the QR string or record was last updated in the system. String (ISO 8601 DateTime)

Sample Response Body

CASE A → NEW INSERT:

CASE B → DUPLICATE FOUND → SOME UPDATED FIELDS ARE THERE :

CASE C → DUPLICATE FOUND → NO FIELDS TO UPDATE :

Sample Error Response: