Sign in
FXRate

Query FX

Currently in sandbox only

Returns the real-time FX-Rate and the amount in the beneficiary currency.

post/v4/clients/{ClientID}/fxrate

Path parameters

ClientIDstring required

22-character <glossary:ClientID>. Ask TabaPay Support if you need to specify a <glossary:SubClientID>.

Request body

fromCurrencystring required

ISO 4217 Currency Number.

The currency of the amount you would like to convert from.

Example: If you are converting from (USD) 840 to (CAD) 124, this would be 840.

toCurrencystring required

ISO 4217 Currency Number.

The currency of the amount you would like to convert to.

Example: If you are converting from (USD) 840 to (CAD) 124, this would be 124.

amountstring required

Transaction Amount.

See how to properly format an amount.

networkstring required

Either:

  • visa
  • mastercard
  • bank

Response

The FX Rate has been queried and the process is complete.

SCinteger

HTTP Status Code

ECstring

Internal Error Code.

Present if SC is 200.

convertedAmountstring

This is the converted amount without markup applied. TabaPay will return the payment network rates. Formatting of amounts in the FX API response will be per the payment network rules.

conversionRatestring

A Decimal Conversion Rate without markup applied.

Changes

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