Skip to main content

FeePaymentRequest

As part of a successful user deposit, withdrawal, or transfer it is possible to transfer part of the funds to the specific merchant account and collect fees.

The fee are transfered only if the main transaction is successful.

There are three options to determine the recipient merchant account:

  • fee payment is received in the merchant account in the same currency as the main transaction. In that situation, the recipientCurrency and merchantAccountId must be skipped.

    The merchant needs to have an account in the same currency as the main transaction.

  • fee payment is received by the merchant in the desired currency defined in recipientCurrency parameter. This is useful if merchants need to receive the payment in a specific currency and avoid funds segmentation. If needed currency conversion is applied using the official Skrill FX rates.

  • fee payment is received by the merchant in the desired merchant account defined in merchantAccountId parameter. This can be used if the merchant has multiple accounts in the same currency and recipientCurrency can not be used to determine the desired recipient account.

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
FeePaymentRequest
{
  "amount": 1000,
  "currency": "EUR",
  "paymentReason": "OTHER_FEE",
  "merchantId": "500005",
  "recipientCurrency": "EUR",
  "merchantAccountId": "100001"
}