Request For Quote
Endpoint: POST https://api.zamp.finance/api/client/:clientid/customer/:customerid/transfer/quote
This API will create a quote for payout
Request Body
| Key | Value | Description | Optional |
|---|---|---|---|
| source_amount | Float | amount that will be deducted from the source account (only one of source or receiving amount is required, if sent both, source amount will be given priority) | Y |
| receiving_amount | Float | final amount that will be received by the recipient (only one of source or receiving amount is required, if sent both, source amount will be given priority) | Y |
| source_currency_code | String | source currency of the amount in String format (USD,USDC_ETH) | N |
| beneficiary_id | String | Beneficiary Id of the recipient | N |
| account_id | String | Account Id from which funds will be debited | N |
| destination_currency_code | String | destination currency of the amount in String format (USD,USDC_ETH) | N |
Request JSON Representation
{
"source_amount": 20,
"source_currency_code":"AED",
"destination_currency_code":"USDC_ETH",
"account_id":"fv4g64_65KDNZgzWG67iVxQbm4e6X_04_24",
"beneficiary_id":"nb96dj_YnV8qkadeGyQHhy6cPm3TE_07_18"
}
Response JSON Representation
Transaction Information Documentation
Response Body
The response body provides detailed information about a specific transaction.
Fields
| Key | Type | Description | Required |
|---|---|---|---|
| id | string | The unique identifier of the transaction. | Yes |
| corridor_id | string | The identifier of the transaction corridor. | Yes |
| source_amount | number | The amount of money being sent from the source. | Yes |
| source_currency_code | string | The currency code of the source amount (e.g., AED). | Yes |
| total_fees | number | The total fees for the transaction. | Yes |
| total_fees_currency | string | The currency code for the total fees (e.g., AED). | Yes |
| converted_amount | number | The amount after conversion. | Yes |
| exchange_rate | number | The exchange rate applied to the transaction. | Yes |
| receiving_amount | number | The amount the recipient will receive. | Yes |
| receiving_currency_code | string | The currency code of the receiving amount (e.g., USDT_ETH). | Yes |
| created_at | string | The timestamp when the transaction was created (ISO 8601 format). | Yes |
| updated_at | string | The timestamp when the transaction was last updated (ISO 8601 format). | Yes |
| expired_at | string | The timestamp when the transaction expires (ISO 8601 format). | Yes |
| gas_fees | number | The gas fees associated with the transaction. | Yes |
| platform_fees | number | The platform fees associated with the transaction. | Yes |
Example JSON Response
{
"id": "5tt1st_2vQPHBCKuT8woPaCN3qWg4_06_10",
"corridor_id": "5tt1st_AwM7AxVdlkidujDqDrV6aO_08_31",
"source_amount": 54,
"source_currency_code": "AED",
"total_fees": 6.0108,
"total_fees_currency": "AED",
"converted_amount": 47.9892,
"exchange_rate": 1,
"receiving_amount": 47.98,
"receiving_currency_code": "USDT_ETH",
"created_at": "2024-06-10T05:24:17.552984521Z",
"updated_at": "2024-06-10T05:24:17.552984619Z",
"expired_at": "2024-06-10T05:26:17.552984696Z",
"gas_fees": 5,
"platform_fees": 1.0108
}
Error codes
| HTTP Code | Error Response | Description |
|---|---|---|
| 400 | {"code":"INVALID_JSON","message":"Please check the request payload."} | The request body contains invalid JSON. |
| 400 | { "code":"CORRIDOR_NOT_ACTIVE", "message":"Corridor Not Active"} | Source currency to destination corridor is not active. Contact Zamp team to enable this pair |
| 404 | { "code":"RECORD_NOT_FOUND", "message":"Unable to find the record requested."} | Failed to find source account 2. Failed to find the beneficiary 3. Failed to find the corridor 4. Error getting merchant corridor configurations 5. Merchant not found |
| 403 | {"code":"ACCESS_FORBIDDEN","message":"You are not authorized to access this record."} | The Merchant is not allowed to access the requested resource (account). |