Sign in

v1

latestOpenAPI 3.1.02026-07-245361280.3 KB
Currency exchange

Create a quote

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

post/payouts/v3/quote

Request body

countrystring required

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

source_currencystring

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

destination_currencystring required

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

source_amountnumber float

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

destination_amountnumber float

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

Example request

{
  "country": "CO",
  "source_currency": "USD",
  "destination_currency": "COP",
  "source_amount": 100,
  "destination_amount": 419439.11
}

Response

Quote created

status_codestring int

Quote generation status code.

statusstring

Quote generation status description.

status_detailstring

Quote generation status detail.

idstring

Unique ID generated for the quoted FX rate.

created_datestring date-time

Creation date and time for the quoted FX rate.

expiration_datestring date-time

Expiration date and time for the quoted FX rate.

Example response

{
  "status_code": "200",
  "status": "CREATED",
  "status_detail": "Quote created successfully",
  "id": "60sYJU1pTCPB3vJoOFG0XCBox9SdMJbznxb0",
  "created_date": "2023-09-05T17:21:29.000+0000",
  "expiration_date": "2023-09-06T17:21:29.000+0000",
  "details": {
    "country": "CO",
    "source_amount": 100,
    "source_currency": "USD",
    "destination_amount": 419439.11,
    "destination_currency": "COP",
    "exchange_rate": 4194.3911,
    "exchange_rate_official": 4214.6213,
    "country_markup_percentage": 0.48,
    "exchange_rate_spread": 20.2301
  },
  "fees": {
    "amount": 1.6,
    "currency": "USD"
  },
  "taxes": {
    "amount": 0.09,
    "currency": "USD"
  },
  "debit": {
    "amount": 101.69,
    "currency": "USD"
  }
}