Skip to main content

Request For Quote

Endpoint: POST https://api.zamp.finance/api/client/:clientid/customer/:customerid/internal/transfer/quote

This API will create a quote for payout

Request Body

KeyValueDescriptionOptional
source_amountFloatamount 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_amountFloatfinal 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_codeStringsource currency of the amount in String format (USD,USDC_ETH)N
destination_account_idStringAccount Id to which funds will be creditedN
source_account_idStringAccount Id from which funds will be debitedN
destination_currency_codeStringdestination currency of the amount in String format (USD,USDC_ETH)N

Request JSON Representation

{
"source_account_id": "rt5g64_65KDNZgzWG67iVxQbm4e6X_04_24",
"destination_account_id": "5tt1st_Rak55WriSVy9vco1fY9BAD_08_31",
"source_currency_code": "AED",
"destination_currency_code": "USD",
"source_amount": 1000.00
}

Response JSON Representation

Transaction Information Documentation

Response Body

The response body provides detailed information about a specific transaction.

Fields

KeyTypeDescriptionRequired
idstringThe unique identifier of the transaction.Yes
corridor_idstringThe identifier of the transaction corridor.Yes
source_amountnumberThe amount of money being sent from the source.Yes
source_currency_codestringThe currency code of the source amount (e.g., AED).Yes
total_feesnumberThe total fees for the transaction.Yes
total_fees_currencystringThe currency code for the total fees (e.g., AED).Yes
converted_amountnumberThe amount after conversion.Yes
exchange_ratenumberThe exchange rate applied to the transaction.Yes
receiving_amountnumberThe amount the recipient will receive.Yes
receiving_currency_codestringThe currency code of the receiving amount (e.g., USDT_ETH).Yes
created_atstringThe timestamp when the transaction was created (ISO 8601 format).Yes
updated_atstringThe timestamp when the transaction was last updated (ISO 8601 format).Yes
expired_atstringThe timestamp when the transaction expires (ISO 8601 format).Yes
platform_feesnumberThe 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",
"platform_fees": 1.0108
}

Error codes

HTTP CodeError ResponseDescription
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).