Query FXRate

Coming Soon

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


URL:

https://<FQDN>/v4/clients/<ClientIDISO>/fx


Request:

JSON Name Value Required Default Description
type String
4 characters
Either push or pull
R Transaction Type
The direction of the transaction impacts the FX Rate
sourceCurrency String
3-digit code
R ISO 4217 Currency Number
The source currency.
On a push, the originator's currency.
On a pull, the beneficiary's currency
destinationCurrency String
3-digit code
R ISO 4217 Currency Number
The destination currency.
On a push, the beneficiary's currency.
On a pull, the originator's currency
amount String
Amount
R Transaction Amount
network String
Either visa, mastercard, or bank
R Transaction Network

Sample Request:

Pack your Request, the following Samples shown here are unpacked only for human readability:
Query FXRate:

{
  "type": "push",
  "sourceCurrency": "840",
  "destinationCurrency": "826",
  "amount": "10.00",
  "network" "visa"
}

Response:

Status Codes:

Status Code Description
200 OK The FX Rate has been queried and the process is complete.
207 Multi-Status One or more failures occurred while processing the Request.

See Status Codes for other possible Status Codes that might be returned.


Response Data:

JSON Name Value Description Status Code
200 207 Other
SC Integer
3-digit code
HTTP Status Code O
EC String
1 or 8 characters
Internal Error Code O
EM String Error Message O O
sourceAmount String
Amount
On a push, this is the transaction amount.
On a pull, this is the settlement amount.
sourceCurrency String
3-digit code
ISO 4217 Currency Number
The source currency code.
On a push, the originator's currency.
On a pull, the beneficiary's currency
destinationAmount String
Amount
On a push, this is the settlement amount.
On a pull, this is the transaction amount.
destinationCurrrency String
3-digit code
ISO 4217 Currency Number
The destination currency.
On a push, the beneficiary's currency.
On a pull, the originator's currency
conversionRate String
Decimal
Conversion Rate without markup applied.
rateExpiration String
yyyy-MM-ddTHH:mm:ssZ Format.
All FX Rates expire 00:00:00 GMT the following calander day.
errors Array of
8 characters
Strings
Array of Internal Error Codes

Sample Response:

Query FXRate:

{
  "SC": 200,
  "EC": "0",
  "sourceAmount": "10.70",
  "sourceCurrency":"840",
  "destinationAmount": "8.22",
  "destinationCurrency": "826",
  "conversionRate": "0.7682243",
  "rateExpiration": "2022-01-29 00:00:00 GMT"
}

Notes:

For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character ("_") to separate the two values: <ClientID>_<SubClientID> where:

  • ClientID is your unique 22-character string and
  • SubClientID is an assigned 4, 6 or 8-digit value.