Quotes

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.

post/api/v1/organizations/{organizationId}/merchants/{merchantId}/quotes

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/organizations/{organizationId}/merchants/{merchantId}/quotes
  • Auth: HTTP bearer

Path parameters

merchantIdstring required

Merchant ID

organizationIdstring required

Organization ID

Request body

amountInnumber

Amount to send (input currency)

amountOutnumber

Amount to receive (output currency)

originCurrencySymbol'ARS' | 'CLP' | 'COP' | 'MXN' | 'USD' | 'PEN' | 'BRL' | 'ETH' | 'USDC' | 'USDT' | 'SOL' | 'TRX' | 'BTC' | 'BOB' | 'MATIC' | 'GBP' | 'CHF' | 'GYD' | 'PYG' | 'SRD' | 'UYU' | 'VES' | 'BZD' | 'CRC' | 'GTQ' | 'HNL' | 'NIO' | 'PAB' | 'CUP' | 'DOP' | 'HTG' | 'EUR' | 'CNY' | 'HKD' | 'SGD' | 'PHP' | 'JPY' | 'CAD' | 'AUD' required

Input currency symbol

destinationCurrencySymbol'ARS' | 'CLP' | 'COP' | 'MXN' | 'USD' | 'PEN' | 'BRL' | 'ETH' | 'USDC' | 'USDT' | 'SOL' | 'TRX' | 'BTC' | 'BOB' | 'MATIC' | 'GBP' | 'CHF' | 'GYD' | 'PYG' | 'SRD' | 'UYU' | 'VES' | 'BZD' | 'CRC' | 'GTQ' | 'HNL' | 'NIO' | 'PAB' | 'CUP' | 'DOP' | 'HTG' | 'EUR' | 'CNY' | 'HKD' | 'SGD' | 'PHP' | 'JPY' | 'CAD' | 'AUD' required

Output currency symbol

executableboolean required

Whether the quote is executable

paymentMethodstring

Payment method ID

orderType'PAYIN' | 'PAYOUT' | 'ONRAMP' | 'OFFRAMP' | 'BALANCE_TRANSFER' | 'CRYPTO_PAYOUT' | 'PAYMENT_LINK' | 'INTER_MERCHANT_TRANSFER' required

Type of order - determines valid currency pairs and network requirements

network'ETHEREUM' | 'POLYGON' | 'SOLANA' | 'TRON' | 'BSC' | 'BITCOIN' | 'BASE' | 'ALGORAND'

Blockchain network for crypto quotes. Required for ONRAMP and OFFRAMP, ignored for fiat-to-fiat orderTypes.

merchantIdstring

Merchant ID for the quote

isInvoicingboolean

Whether the quote is for invoicing purposes

contactIdstring

Contact ID for the recipient. Required for Asian currency quotes (e.g., HKD)

bankAccountIdstring

Bank Account ID for routing. When provided, the bank account country is used for PSP routing decisions instead of the contact country.

destinationCountrystring

Destination country code for PSP routing. Used when no contactId or bankAccountId is provided to determine the payout corridor.

Example request

{
  "originCurrencySymbol": "CLP",
  "destinationCurrencySymbol": "USDC",
  "orderType": "ONRAMP",
  "network": "POLYGON",
  "destinationCountry": "GB"
}

Response

Quote created successfully

idstring required

ID of the quote, if applicable

originCurrencySymbolstring required

Original origin currency symbol

destinationCurrencySymbolstring required

Original destination currency symbol

validForSecondsnumber required

Number of seconds the quote is valid for

validUntilstring date-time required

Timestamp when the quote expires

feenumber required

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

taxesnumber required

Total tax applied directly to the transaction amount

requestedAmountInnumber required

Original amountIn from request, if applicable

requestedAmountOutnumber required

Original amountOut from request, if applicable

finalAmountInnumber required

Final total amount the user pays in the origin currency

finalAmountOutnumber required

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

exchangeRatenumber required

Effective exchange rate after all fees and taxes directly on amount are considered

orderTypestring required

Type of order from the request

componentsQuoteResponseComponent[] required

Detailed breakdown of all fees and taxes applied

summaryQuoteResponseSummary required

Changes

No recorded changes to this operation across all 1 revision of this API.