Payments API ReferenceQuotes

Create a quote

Creates a new quote for currency exchange or payment operations. The quote provides pricing information including exchange rates, fees, and estimated processing times based on the specified parameters such as amount, source and destination currencies, and operation type.

Path parameters

merchantIdstringRequired
Merchant ID
organizationIdstringRequired
Organization ID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
originCurrencySymbolstringRequired
Input currency symbol
destinationCurrencySymbolstringRequired
Output currency symbol
executablebooleanRequired
Whether the quote is executable
orderTypestringRequired

Type of order (e.g., PAYIN, PAYOUT, ONRAMP)

amountIndoubleOptional

Amount to send (input currency)

amountOutdoubleOptional

Amount to receive (output currency)

paymentMethodstringOptional
Payment method ID

Response

Quote created successfully
idstring
ID of the quote, if applicable
originCurrencySymbolstring
Original origin currency symbol
destinationCurrencySymbolstring
Original destination currency symbol
feedouble

Total effective fee charged (base fees + tax on fees), in origin currency terms

taxesdouble
Total tax applied directly to the transaction amount
requestedAmountIndouble
Original amountIn from request, if applicable
requestedAmountOutdouble
Original amountOut from request, if applicable
finalAmountIndouble
Final total amount the user pays in the origin currency
finalAmountOutdouble

Final net amount the user/recipient receives in the destination currency

exchangeRatedouble
Effective exchange rate after all fees and taxes directly on amount are considered
orderTypestring
Type of order from the request
componentslist of objects
Detailed breakdown of all fees and taxes applied
summaryobject
Summary of financial calculations

Errors