Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Calculate a currency conversion and lock an exchange rate before initiating a transfer.

post/v1/global-payout/money/convert

Headers

Authorizationstring required
Example:Bearer <token>

Bearer token for authentication.

accountIdstring required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

amountnumber required
currencystring required

ISO 4217 source currency code.

destinationCurrencystring required

ISO 4217 destination currency code.

transactionTypestring required

Example request

{
  "amount": 15,
  "currency": "USD",
  "destinationCurrency": "EUR",
  "transactionType": "EXCHANGE"
}

Response

Conversion calculated successfully.

codestring
descriptionstring

Example response

{
  "code": "00",
  "description": "Successful",
  "data": {
    "fromAmount": 15,
    "fromCurrency": "USD",
    "fromFormatted": "$15.00",
    "toAmount": 13.04,
    "toCurrency": "EUR",
    "toFormatted": "13,04 €",
    "spreadAmount": 0.12,
    "spreadCurrency": "EUR",
    "exchangeRateId": "01kkk4b7rh8pcvtw1s1nxs144s",
    "currencyPairName": "EUR/USD",
    "feeCurrency": "USD"
  }
}