User Flow

The user needs to follow a series of steps on the client platform to purchase crypto as given below:

Onramp Hosted SDK

Saber’s Hostel SDK can be integrated by following the below mentioned steps. The integration is done in two steps:

• Sandbox Testing: Initial testing of integration

• Production: Final integration for going live

The steps to integrate are SDK are highlighted below:

The overall integration includes two major areas:

1. User Registration: Creation of user on Mudrex’s system and generate a UUID for the user for payment processing

2. Payment Initiation: Generation of URL for payment where the user needs to be redirected for Onramp

User Registration

The user registration part contains the following steps:

Steps to Register a User

To be able to make payments a user has to be first registered with Mudrex. To register a user on Mudrex you need to follow the steps:

1. Generate a secret key for user registration using the following script

var timestamp = Math.floor(Date.now() / 1000).toString();
var sigString = clientId + timeInSeconds;
var secret = CryptoJS.HmacSHA256(sigString, clientSecrect).toString().toUpperCase();

2. Use this API endpoint to register a user

curl --location 'https://mudrex.com/api/v1/user/client_user' \
--header 'X-Timestamp: {{timestamp}}' \
--header 'X-Client-Id: •••••••' \
--header 'X-Secret-Key: •••••••' \
--header 'X-Request-Id: 123456789876' \
--data-raw '{
    "user_uuid": "77c4562e-ce47-4054-9d4e-4df69ca61ac2",
    "client_user_id": "Abhishek-TestAcc",
    "email": "kk@mail1.com",
    "phone":"8734567891"
}'

{
    "success": true,
    "data": {
        "client_user_id": "",
        "user_id": "d57626e7-d6f3-44e0-bc82-12c5f42843af"
    }
}

Payment Initiation

Post user registration, URL needs to be generated for payment where the user will be redirected

Steps to Initiate Payment

To generate a payment URL for the user where he must be redirected, follow these steps:

1. Generate a secret key for payment using the following script. Please note that this script is slightly different from the one used at the time of user registration

var timestamp = Math.floor(Date.now() / 1000).toString();
var sigString = clientId + timeInSeconds + "sdk" + user_id;
var secret = CryptoJS.HmacSHA256(sigString, clientSecrect).toString().toUpperCase();

2. Pass the following parameters as URL params to the base payment URL

KYC Sharing

If the user has already completed KYC on client’s platform, the same data can be shared without the need for re-KYC. The steps are as follows:

The existing KYC data of user can be shared with Mudrex using this API Endpoint

Method	URL
POST	https://mudrex.com/api/v1/user/client_user/kyc

Headers	Description	Values
X-Timestamp	Timestamp used to generate the secret	string
X-Client-Id	Client ID provided by Mudrex	string
X-Secret-Key	The secret key generated in the first step	string
X-Request-Id	For client reference
X-User-Id	UUID of the user	string

⚠️

In the above endpoint,

1. legal_name, poi (PAN number), poa (Aadhar number) is required (the rest are optional)

2. dob should be in dd-mm-yyyy format

3. gender must be either M or F

Example

curl --location 'https://mudrex.com/api/v1/user/client_user/kyc' \
--header 'X-Timestamp: 1709120158' \
--header 'X-Client-Id: 18e963ea-39fd-4a1b-b1e6-decbfe791d31' \
--header 'X-Secret-Key: <key>' \
--header 'X-Request-Id: 123456789876' \
--header 'X-User-Id: cbbb71b2-0dea-40d1-a7df-3bcdd62d1caa' \
--header 'Content-Type: application/json' \
--data-raw '{
   "legal_name":"KARTIKEY AGARWAL", 
   "poi":"AWSPP1410L",    
   "poa":"500100111232", 
   "dob":"31-01-2000",   
   "gender":"M",      
   "income":"1,00,000-5,00,000",  
   "email":"kartikey@mudrex.com", 
   "phone":"8553383091", 
   "occupation":"professional", 
   "address":"my address is a addreess" 
}'