Fetching Payment Beneficiary
Fetching Beneficiary Details for Onramp Transactions
When initiating an onramp transaction, the beneficiary details need to be fetched for specific payment methods. These details vary based on the payment method being used. However, not all payment methods require beneficiary details (e.g., UPI Intent methods).
This guide explains how to use the API to fetch beneficiary details for supported payment methods.
API Endpoint
<https://mudrex.com/api/v1/wallet/conversion/fiat/methods/>\<payment_method>/beneficiary?type=buy&fiat=<fiat>&crypto=<crypto>
Supported Payment Methods
- Replace
<payment_method>
with the specific payment method, such asbank_transfer
orupi_transfer
.
Mandatory Query Parameters
Parameter | Type | Description |
---|---|---|
type | String | Type of transaction. For onramp transactions, use buy . |
fiat | String | The fiat currency being converted (e.g., INR, EUR, GBP). |
crypto | String | The cryptocurrency being purchased (e.g., USDT, USDC). |
Example Request
curl --location 'https://mudrex.com/api/v1/wallet/conversion/fiat/methods/upi_transfer/beneficiary?type=buy&fiat=INR&crypto=USDT' \
--header 'X-Timestamp: {{timestamp}}' \
--header 'X-Client-Id: •••••••' \
--header 'X-Request-Id: h' \
--header 'X-Secret-Key: •••••••'
{
"success": true,
"data": {
"id": "15adbb9b-3593-45d8-964e-debbc3474b22",
"aggregator_id": "b4427086-4940-4c8f-a800-98319f3277e8",
"bank_name": "RPFAS TECHNOLOGIES PRIVATE LIMITED",
"ifsc_code": null,
"account_number": null,
"upi": "paytmqr28100505010114pimg61rdg6@paytm",
"account_name": "RPFAS TECHNOLOGIES PRIVATE LIMITED",
"account_type": null
}
}
Response Details
Key | Type | Description |
---|---|---|
id | String | Unique identifier for the beneficiary record. |
aggregator_id | String | Identifier for the aggregator handling the transaction. |
bank_name | String | Name of the beneficiary's bank or payment service. |
ifsc_code | String | IFSC code for the bank account, if applicable (null for non-bank methods). |
account_number | String | Bank account number for the beneficiary (null for UPI-based payment methods). |
upi | String | UPI ID for the transaction, if applicable. |
account_name | String | Name associated with the beneficiary account. |
account_type | String | Type of the bank account, if applicable (null for methods like UPI Intent). |
These details might differ for different payment methods.
Notes
- Beneficiary Requirements:
- Some payment methods like UPI Intent do not require fetching beneficiary details.
- Ensure to verify whether the payment method being used requires beneficiary details before calling this API.
- Customization:
- The response structure may vary slightly depending on the payment method and service configuration.
- Real-Time Updates:
- Always use the latest beneficiary details fetched via this API for every transaction to ensure accuracy
Check more details about API endpoint here.
Updated 26 days ago