JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Pre-Requisites

General:

Merchant Id - This is your identifier in the Juspay systems. This is used in all API Calls. It will be provided to you by the Juspay team
Client Id - This is used in all SDK calls as an identifier for client-side requests. It will be the same as your merchant ID.
Juspay Dashboard - Merchants are required to procure the Juspay merchant dashboard access by creating an account (Sandbox / Production) or from Juspay Business SPOC.
- Unified Juspay dashboard Guide can be referred for the gateway setup, payment instruments enablement/disablements, Security key generation, Webhook URL Configuration, batch operations, traffic monitoring and analytics.
API Key - Juspay uses HTTP Basic Auth for authentication. API Key is used to authenticate the Server-to-Server API Calls.

API Key Generation on Juspay Dashboard

Detailed The API request expects a Basic Authorization header. The header value can be obtained by concatenating your API Key with a colon (:) and doing a base-64 encode on it
- Sample Authorization Header:
  
  API Key: 1cc33A5F5D6aa54AB20CF6FbbC8558
  Encoding Format: 1cc33A5F5D6aa54AB20CF6FbbC8558:
  Authorization Header / Base64encoded API Key:
  Basic MWNjMzNBNUY1RDZhYTU0QUIyMENGNkZiYkM4NTU4Og==
During Onboarding, the production account provided is under restricted mode. In the restricted mode, number of transactions and the amount per transaction is configurable. We will remove the restricted mode once the integration is completed and you receive a QA signoff from Juspay

PIX via Open Finance:

Before you begin integrating the PIX via Open Finance flow, please review the following requirements. These requirements are in addition to those mentioned above. Completing these steps upfront will ensure a smooth and successful setup.

1. Account & Onboarding

Your Juspay account must be enabled for Open Finance ITP (Payment Initiation) flows.

Action: Contact your Juspay POC or support team to initiate the onboarding process. We will handle the necessary configurations to enable this flow for your merchant account.

2. Mobile Application Details

To link your app securely with the banking partners, you must provide your application's unique identifiers to Juspay.

For Android: The required identifier is your app's androidApkHash.
For iOS: The required identifier is your app's bundle ID.
Action: Provide these identifiers to the Juspay team during onboarding. Juspay uses this information to register your application with the banks through the Dynamic Client Registration (DCR) process.

3. App-Site Association Configuration

For the biometric flow to function correctly and securely, your application must be verified as the legitimate owner of the web domain used for the operations. This is done by hosting a specific verification file on your server.

For Android: You must host an assetlinks.json file at /.well-known/assetlinks.json on your domain. This file must contain theandroidApkHash of your application.
For iOS: You must host an apple-app-site-association file at /.well-known/apple-app-site-association on your domain. This file must list your app's bundle ID.
Action: Ensure these files are correctly configured and publicly accessible on the domain associated with your merchant account. This is a mandatory step for FIDO/Passkey operations.