Skip to main content

FeePayment

Fee payment information.

amountint64required

Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

Default value: 0
Example: 1000
currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR
paymentReasonFeePaymentReason (string)required

Fee payment reason.

  • SENDER_FEE - Fee that will be applied to sender party of transfer collected into partner merchant wallet.
  • RECIPIENT_FEE - Fee that will be applied to recipient client of transfer collected into partner merchant wallet.
  • DEPOSIT_FEE - Fee charged for deposit transactions collected into partner merchant wallet.
  • WITHDRAWAL_FEE - Fee charged for withdrawal transactions collected into partner merchant wallet.
  • MERCHANT_FEE - Fee for the payment service collected into partner merchant wallet.
  • PAYSAFE_FEE - Fee collected by Paysafe for the provided payment service. Usually Paysafe Fee is not directly applied to customer transactions.
  • ATM_FEE - Fee for ATM service, when using prepaid cards.
  • FX_FEE - Fee applied, when payment requires currency exchange.
  • OTHER_FEE - It could be used for any additional, unspecified fees that may be applied to a transaction

Possible values: [MERCHANT_FEE, ATM_FEE, FX_FEE, PAYSAFE_FEE, OTHER_FEE, SENDER_FEE, RECIPIENT_FEE, DEPOSIT_FEE, WITHDRAWAL_FEE]

Default value: OTHER_FEE
merchantIdstring

The target merchant wallet id.

Example: 500005
recipientCurrencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR
merchantAccountIdstring

The target account in which the payment is accepted. If not specified the account is determined by the main transaction currency.

Example: 100001
fxAmount object

(In Development)

Contains the amount in converted currency during currency conversion.

amountinteger

Converted amount (in minor units).

ratenumber

Currency conversion rate.

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

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

Example: EUR
FeePayment
{
  "amount": 1000,
  "currency": "EUR",
  "paymentReason": "OTHER_FEE",
  "merchantId": "500005",
  "recipientCurrency": "EUR",
  "merchantAccountId": "100001",
  "fxAmount": {
    "amount": 0,
    "rate": 0,
    "currency": "EUR"
  }
}