Sign in
Payouts

Gets an FX held rate.

A held rate differs from an indicative rate in that it is a guaranteed rate for a specific period of time. The maximum validity validity period a held rate can be obtained for is 24 hours.

<b>Authorization</b>: End user or Merchant token is required.

get/api/v1/payouts/fxheldrate/{source}/{destination}/{validForMinutes}

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/payouts/fxheldrate/{source}/{destination}/{validForMinutes}
  • Auth: API key in header Authorization

Path parameters

source'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC' required

The source currency for the FX held rate.

destination'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC' required

The destination currency for the FX held rate.

validForMinutesinteger required

The number of minutes the held rate is being requested for.

Response

OK

sourceCurrency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC'
destinationCurrency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC'
exchangeRatenumber double

The price at which the transaction will buy the source currency using the destination currency.

quoteIDstring nullable
expiryTimestring date-time

Changes

No recorded changes to this endpoint across all 2 revisions of this API.