Get exchange rate
POST/api/exchange-rate/information
Returns the exchange rate and an amount between two currencies with the selected API payment method.
Use this method to see the rate and the converted amount before a payout or a transfer that changes currency.
actiondefines which sideamountrefers to, as in the payout itself. SeeGIVEandGET.- For crypto invoices, Check crypto invoice returns the calculated amounts directly.
Step by step: Step 3: Check exchange rate information.
Request
- application/json
- Body
- Example
Bodyrequired
Possible values: [INTERNAL_OWN, INTERNAL_OTHERS, CRYPTOWALLET, CRYPTO_INVOICE, CRYPTO_EXTERNAL]
Possible values: [GIVE, GET]
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
{
"apiPaymentMethod": "INTERNAL_OWN",
"amount": 100,
"action": "GIVE",
"currency": "USD",
"desiredCurrency": "EUR"
}
Responses
- 200
OK
- application/json
- Schema
- Example
Schema
commissionData object
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
exchangePlan object
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
rates object
property name* PairBigDecimalBigDecimal
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
commission object
Possible values: [USD, EUR, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
{
"commissionData": {
"currency": "USD",
"totalCommission": 1.5
},
"exchangePlan": {
"from": "USD",
"to": "EUR",
"intermediate": null
},
"from": "USD",
"to": "EUR",
"amount": 100,
"providerAmount": 92,
"commission": {
"fixedCommissionCurrency": "USD",
"fixedCommission": 0,
"percentCommission": 1.5
}
}