Merchant Onboarding
This section provides a comprehensive, step-by-step guide to merchant onboarding on Payment Gateway. From the initial step of receiving merchant credentials to hitting the APIs, the complete onboarding process is explained in this section.
Step 1 : Network Connectivity
Merchant will be required to whitelist the PSP’s IP and domain at there end and vice versa at PSP’s end to support the request and response calls for UAT and Prod respectiviely.
Once the whitelisting is completed at both the end , we would check the complete end to end connectivity from TPAP to NPCI via PSP for both forward and reverse traffic by initiating telnet.
Step 2 : UAT Environment readiness
In order to enable merchant for UAT testing. We will create a instance/ app server and will proceed with deploying the application in the stack to support all the API calls. We will initiate and check the HBT API call to check if the application and the network connectivity is properly established.
VMN onboarding in UAT , to enable the customer onboarding on the stack.
Step 3 : Merchant Credentials
Once a Bank Partner is chosen, merchant will be required to complete an onboarding form. Upon submission of the form with the necessary details, Juspay will then provide the following merchant credentials which are required for making API calls. Here’s a quick understanding of the credentials that we share.
Merchant Id : A unique identifier for the Merchant in the PSP system.
Merchant Channel Id : Unique id for the channel via which request is made.
Merchant VPA : This is the Virtual Payment Address assigned to the merchant for receiving payments.
MCC : A 4-digit Merchant Category Code used to categorize the payee.
KID : A unique Key ID to identify the public-private key pair used for signature generation within the PSP system.
PG Public Key : This is the PSP's public key, employed for the verification of API responses and callbacks.
Once the merchant receives the details mentioned above, the merchant will be required to provide a Merchant Callback URL
for receiving Webhooks and the Merchant Public Key for verifying the requests sent by the merchant. After these details are shared, Juspay will enable the merchant and can start hitting the APIs. For guidance on generating a Public-Private key pair and understanding the callback URL, please refer below.
Step 4 : Generate API Keys
We use JSON Web Signature (JWS) to ensure the integrity of data exchanged between merchant and our system. Private key is used to generate the JWS Signature and Public key is used for verifying it. It is crucial to securely store the Private Key within a cryptographic vault on the merchant's servers and under no circumstances should the Private Key be exposed to the client or any external parties.
Here are the step-by-step instructions to generate a public-private key pair.
Generating Private Key
To generate the Private Key, run the below command on terminal.
The private key generated will be stored as a file named ‘privateKey.pem’ and is to be used to generate the Public key using the procedure given below.
Generating Public Key
Public key is always generated on top of the private key as they both come in pair. To generate the Public key, run the below command on the terminal.
The public key generated will be stored as a file named ‘publicKey.pem’ and is required to be shared with payment gateway for verifying the requests sent by the merchant.
Step 5 : Callback URL
For every API call made, we provide a callback (commonly known as a webhook) to your server. These callbacks serve as direct notifications, updating you on events status for transactions, refunds etc. Configuring callbacks remains is mandatory step in our process. As a merchant, it is required to share your designated callback URL with Juspay to receive these callbacks for API calls.
For automation of Reports(MIS & Settlement files) via SFTP. Merchant’s server Username & SSH Public Key need to be shared with PSP/Bank for whitelisting.
Contact Us
Should you have any questions or clarifications, please feel free to reach out to our dedicated team. We are always happy to help!
For any Integration queries, please reach out to upi.integration@juspay.in
For any Post-Settlement queries, be it reconciliation or disputes, please reach out to reconops@juspay.in
For any Production queries, be it technical or general, please reach out to upimerchantsuccess@juspay.in
For any escalation / business queries, please reach out to product.upi@juspay.in / upi.biz@juspay.in
- Have questions?
- Need help? Contact support
- LLM? Read llms.txt
