Create a quote

This endpoint generates an FX rate for a particular currency pair.

When this service is called, it returns a quote_id, which uniquely identifies the quoted foreign exchange (FX) rate, including any applicable fees and taxes. This quote_id can be used in subsequent requests to create Payouts, as long as it remains within the quote's validity period.

There are three possible ways to create a quote ID configuration:

  • Request with no amount specified
  • Request specifying the source amount
  • Request specifying the destination amount

For more information on how to configure each one, check the Create a quote page.


Configuration required: to use the Quote API, please contact your Technical Account Manager or email us at [email protected] to request setup.


Body Params
string
required

Country code of the destination. ISO-3166 country code ISO-3166 country code.

Length: 2.

string
Defaults to USD

Currency code for the source amount. ISO-4217 currency code.

Length: 3.

string
required

Currency code for the destination amount. ISO-4217 currency code.

Length: 3.

float
required
Defaults to 100

Payout source amount expressed in the currency entered in source_currency. When creating a payout, specify the exact same amount specified in this parameter.

Max. Length: 10, 2 decimals.

float

Payout destination amount expressed in the currency entered in destination_currency. When creating a payout, specify the exact same amount specified in this parameter.

Max. Length: 10, 2 decimals.

Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json