Body
COFT | Alt ID Onboarding API
This API facilitates merchant and submerchant onboarding to COFT and ALT_ID
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/tokenization/onboarding
Production Link
POST
https://api.juspay.in/tokenization/onboarding
Authorization Header
Basic Auth
*
Base 64 Encoding
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
*
String
Mandatory
Please pass merchant-id assigned to you by Juspay
content-type
*
String
Mandatory
application/json
version
*
String
Mandatory
Pass recent date to get the updated API response.
Example:- 2023-11-01
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Request Schema: application/json
Parametres
associateId
*
String
Mandatory
A unique value against the submerchant. This id will be passed in fetch onboarding api in the key submerchantId.
Note: Travel Networks should use it to pass airline codes.
companyDetails
*
CompanyDetails
Mandatory
Details of submerchant (Partner’s/Reseller’s merchant)
legalName
*
String
Mandatory
Submerchant’s Legal Name
tradeName
*
String
Mandatory
Submerchant’s Trade Name
websiteURL
*
String
Mandatory
Submerchant’s website URL
contactEmail
String
Optional
Submerchant’s contact email
businessIdentificationType
*
String
Mandatory
Type of submerchant’s identifier
Example : PAN
businessIdentificationValue
*
String
Mandatory
Submerchant’s identifier value
Example : PAN Number
flow
*
ENUM
Mandatory
Possible values: ALT_ID or COFT
network
String
Optional
This is passed to enable specific networks
If not passed, then all networks will be enabled
200 : Success
Response Body
status
*
String
Mandatory
Status of the API call
Possible values: Success or Failure
associateId
*
String
Mandatory
Submerchant Identifier
response
*
Json
Mandatory
Response contains onboarding status of the partner merchant on AltID flow at various networks
401 : Authentication Failed
Response Body
errorMessage
*
String
Mandatory
Reason for failure
errorCode
*
String
Mandatory
Error Code