---
title: "Query FX"
method: POST
path: "/v4/clients/{ClientID}/fxrate"
tags: ["FXRate"]
---

# Query FX

`POST /v4/clients/{ClientID}/fxrate`

***Currently in sandbox only***

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

## Path parameters

- `ClientID` string, required

## Request body

- QueryFXRequest
  - `fromCurrency` string, 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.
  - `toCurrency` string, 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.
  - `amount` string, required — Transaction Amount. See how to [properly format an amount](/reference/data#how-to-specify-an-amount-value).
  - `network` string, required — Either: - `visa` - `mastercard` - `bank`

## Response `200`

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

- QueryFXResponse
  - `SC` integer — HTTP Status Code
  - `EC` string — Internal Error Code. Present if `SC` is `200`.
  - `convertedAmount` string — 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.
  - `conversionRate` string — A Decimal Conversion Rate without markup applied.

## Other responses

- `207` — One or more failures occurred while processing the Request.

---

[API](https://skmtc.dev/tabapay/apis/tabapay-apis.md) · [All operations](https://skmtc.dev/tabapay/apis/tabapay-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tabapay/tabapay-apis/revisions/154fa3d585cf/schema)