Skip to main content

FxRate

(In Development)

FX Conversion rate token, that contains the FX rate suggested by Paysafe used for currency conversion. This token is obtained using the FX Rate API.

Each token is valid for certain amount of time and allows merchant to preview the exchange operation to his customers and lock the exchange rate for limited time.

sourceCurrencyCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
targetCurrencyCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
senderstringrequired

Wallet customer Id for the FX rate sender.

recipientstring

Wallet customer id of the recipient. Pass this for quotes during Peer to Peer transfer. Defaults to sender if not passed.

idstring
creationTimestring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
expirationTimestring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
fxRatenumberrequired

FX exchange rate between source and target currency.

FxRate
{
  "sourceCurrency": "EUR",
  "targetCurrency": "EUR",
  "sender": "string",
  "recipient": "string",
  "id": "string",
  "creationTime": "2021-07-15T17:54:12Z",
  "expirationTime": "2021-07-15T17:54:12Z",
  "fxRate": 0
}