Skip to main content

Create FX Rate Quote

POST 
/v2/customers/:customerId/fxrate

(In Development)

Create currency exchange rate quote for specific currency to specific target currency from Paysafe.

There are two type of exchange operations that can be triggered usint this quote:

  • Currency conversion inside customer account
  • Currency conversion during transfer operation between two customer, where currency do not match

The quote can be passed as parameter during currency conversion and allows predictable behavior of the operation. Each quote is valid for specific time. If expired quote is passed the currency conversion will fail.

Note ! The exchange rate includes the respective Paysafe fees. It should be noted, that because of the way Paysafe applies the fee some rounding might internlly cause minor difference in the actual conversion output. Usually this would be in customer benefit.

Request​

Path Parameters

    customerId stringrequired

Body

    sourceCurrency Currency (string)required

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

    Currency alphabetic code as specified by ISO 4217

    targetCurrency Currency (string)required

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

    Currency alphabetic code as specified by ISO 4217

    sender stringrequired

    Wallet customer Id for the FX rate sender.

    recipient string

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

Responses​

OK

Schema

    sourceCurrency Currency (string)required

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

    Currency alphabetic code as specified by ISO 4217

    targetCurrency Currency (string)required

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

    Currency alphabetic code as specified by ISO 4217

    sender stringrequired

    Wallet customer Id for the FX rate sender.

    recipient string

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

    id string
    creationTime date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    expirationTime date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    fxRate numberrequired

    FX exchange rate between source and target currency.

Loading...