Skip to main content

FeeTransferRequest

Describes a fee transfer request between two customers.

amountint64required

Transaction amount in minor units.

Example: 1000
currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

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

Example: EUR
recipient object

Contains transfer recipient information. If used in CustomerTransferRequest context, the system tries to resolve email to customerId in the system.

customerIdstring
emailemail

Possible values: <= 150 characters

merchantRefNumstring

Merchant reference number associated with the transaction.

Possible values: <= 50 characters

Example: 5040452805
fxQuotestring

(In Development) FX Quote ID for the transfer in case currency conversion is required. If not passed currency conversion is not perfomed.

transferDetails object

Represents the details of a fee transfer.

reasonFeeTransferReason (string)required

The purpose of the fee transfer.

  • CARD_REPLACEMENT_FEE - Fee for replacing a card that is lost, stolen, or damaged.
  • CARD_FEE - Fee charged on funds paid on to the card.
  • ATM_FEE - Fee for funds withdrawal on ATM.
  • INACTIVITY_FEE - Fee charged for lack of transactions or authorizations.
  • FX_FEE - Fee related to currency exchange.
  • DISPUTE_FEE - Fee charged for resolving disputes related to payments, such as suspected fraud or unfulfilled goods/services.

Possible values: [CARD_REPLACEMENT_FEE, CARD_FEE, ATM_FEE, INACTIVITY_FEE, FX_FEE, DISPUTE_FEE]

descriptionstring

Human readable description for the transfer.

Possible values: <= 200 characters

FeeTransferRequest
{
  "amount": 1000,
  "currencyCode": "EUR",
  "recipient": {
    "customerId": "string",
    "email": "user@example.com"
  },
  "merchantRefNum": "5040452805",
  "fxQuote": "string",
  "transferDetails": {
    "reason": "CARD_REPLACEMENT_FEE",
    "description": "string"
  }
}