Guide
Introduction
Once a merchant is registered with Saber, every user belonging to the merchant must also be registered to process transactions. This forms the foundation of all Saber operations, including on-ramp and off-ramp services.
This guide covers the essential steps and APIs to manage users within Saber Money’s infrastructure. By following these processes, merchants can seamlessly onboard users, ensure compliance, and enable transactions. For detailed API references, please refer to the linked documentation pages.
Overview
To process transactions, two key steps are required:
- Creating a User: Establishing a user profile within the Saber system.
- Performing KYC: Verifying the identity of the user.
Depending on the flow, an additional step of adding a bank account is mandatory.
User Operations
1. Creating a User
A user must be created before any operations can be performed. This involves registering the user in Saber’s system and assigning them a wallet for off-ramp transactions.
-
API Call:
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": "Test ACcount", "email": "[email protected]", "phone": "+918734567891" // E.164 format "+" + country_code + number }'
-
Notes:
- Both email and phone number are mandatory for the user.
- A user wallet is automatically created upon registration.
- The wallet is used for off-ramp purposes.
-
API Reference: Register User
2. KYC for a User
KYC is required for all users to enable transaction operations. There are three methods depending on the flow:
-
KYC Sharing via API:
- Merchants independently verify the user's KYC and share the details of approved user with Saber for reference.
- Depending on the flow, a bank account must be added separately.
-
KYC via Web Widget:
- Saber automates the entire KYC process, including verification and bank account addition.
- Recommended for seamless integration.
-
KYC via Partner URL:
- Certain flows required partner KYC mandatorily. Please refer to the KYC section for more details around it.
-
Get Started: KYC Sharing \ KYC SDK
3. Add Bank Account
For various on-ramp and off-ramp services, users must link a bank account. This can be done in multiple ways:
- Through API Endpoint: The required banking details can be added using the API endpoint. This can be used for INR, AED, EUR and GBP flows.
- Through Web-Widget: For USD onramping, the user needs to link their bank account with Plaid. This is done through our web widget and is a mandatory step to initiate a transaction.
- Post KYC: If using our KYC web-widget, you can prompt the user to add their INR bank account in the same UI, post KYC completion. (This is enabled by default. Please contact Saber team if you need to disable the bank account addition screen in KYC flow)
API Call:
curl --location 'https://mudrex.com/api/user_services/v1/user_kyc/v2/bank_account' \
--header 'X-Timestamp: {{timestamp}}' \
--header 'X-Client-Id: •••••••' \
--header 'X-Secret-Key: •••••••' \
--header 'X-Request-Id: 123456789876' \
--header 'X-User-Id: •••••••' \
--data '{
"bank_account_details": {
"bank_id": "73cbf6b2-04d0-4caf-b61f-6accfd758f04",
"ifsc_code": "SBIN0004855",
"type": "SAVINGS"
},
"action": "add"
}'
- API Reference: Add/Delete Bank
Other User Operations
Operation | Description |
---|---|
Retrieve User | Fetch details of a registered user. |
Update User (under development) | Modify user information to keep profiles accurate. |
Fetch User Wallet Balance | Retrieve wallet balance for Indian users to ensure sufficient funds for off-ramp transactions. |
Important Notes
-
User Authentication:
- Ensure all operations are performed using valid authentication tokens and headers.
-
Error Handling:
- Refer to the respective API documentation for detailed error codes and troubleshooting guidance.
-
Compliance:
- Only KYC-approved users can perform on-ramp and off-ramp operations.
Updated 9 days ago