Overview

This API allows merchants to add or update a bank account for a user. It is primarily used for Indian users who require a bank account to perform off-ramp operations.

Endpoint

URL: https://mudrex.com/api/user_services/v1/user_kyc/v2/bank_account
Method: POST

Headers

Header	Description
`X-Timestamp`	A UNIX timestamp for the request. Used for generating a secure signature.
`X-Client-Id`	Your unique client ID is provided by Saber Money.
`X-Secret-Key`	Your API secret key for authenticating the request. Authentication: Configuring Your Keys
`X-Request-Id`	A unique identifier for the request (optional but recommended).
`X-User-Id`	The unique ID of the user whose bank account is being added or updated.

Request Body Parameters

Parameter	Type	Description	Mandatory
`bank_account_details.account_number`		Bank account number (required in `add` and `update` actions)	Yes (for `add` and `update` actions) Not required for `delete` action
`bank_account_details.bank_id`	`String`	A unique identifier for the bank account. A bank_id is generated after adding/updating the bank account.	Yes (for `delete` action) Not required for `add` and `update` action
`bank_account_details.ifsc_code`	`String`	The IFSC code of the user's bank branch.	Yes
`bank_account_details.type`	`String`	The type of bank account (e.g., `SAVINGS`, `CURRENT`).	Yes
`action`	`String`	The action to perform (`add` to add a new account, `update` to update the account, `delete` to delete the account)	Yes

Sample Request

curl --location 'https://mudrex.com/api/user_services/v1/user_kyc/v2/bank_account' \
--header 'X-Timestamp: 1705491300' \
--header 'X-Client-Id: CLIENT_ID_HERE' \
--header 'X-Secret-Key: SECRET_KEY_HERE' \
--header 'X-Request-Id: 123456789876' \
--header 'X-User-Id: USER_ID_HERE' \
--data '{
   "bank_account_details": {
        "account_number": "73cbf6b2-04d0-4caf-b61f-6accfd758f04",
        "ifsc_code": "SBIN0004855",
        "type": "SAVINGS"
    },
    "action": "add"
}'

Notes

This API is mandatory for Indian users after KYC approval to enable off-ramp transactions.
Ensure the IFSC code is valid and corresponds to the user’s bank branch.
Use unique Request-Id values for tracking each request.

This API ensures seamless integration of bank account management into your platform, enhancing compliance and user functionality.