Fee

  • amount
    Type: integerFormat: int64
    required

    Amount of the fee, in cents.

  • currency
    Type: object · Currency
    required

    Three-letter ISO currency code

    • iso
      Type: string
      required

      Three-letter ISO currency code

    • scale
      Type: integer
      required

      Number of decimal places for this currency

  • type
    Type: string
    max length:  
    5000
    required

    Type of the fee.

  • applied_amount
    Type: integerFormat: int64

    The actual amount that is recorded to the transaction after any rules for discounts or other processing is applied to the original amount. Amount in currency base units. The actual amount equals units / {currency.scale} power of 10. For example, when units is 12312 and {currency.scale} is 2, the actual amount is 12312 / 10^2 = 123.12

  • applied_amount_currency
    Type: object · Currency

    Three-letter ISO currency code

    • iso
      Type: string
      required

      Three-letter ISO currency code

    • scale
      Type: integer
      required

      Number of decimal places for this currency

  • balance_account_id
    Type: string | null

    ID of the balance account that earned the fee.

  • description
    Type: string | null
    max length:  
    5000

    An arbitrary string attached to the object. Often useful for displaying to users.

  • exchange_rate

    Exchange rate if applied on the fee to convert it to the base currency of the payment.

    • from_currency
      Type: object · Currency

      Three-letter ISO currency code

    • rate
      Type: numberFormat: double
    • reversed_rate
      Type: numberFormat: double
    • to_currency
      Type: object · Currency

      Three-letter ISO currency code

  • fixed_amount
    Type: numberFormat: double

    Fixed fee amount in the currency's standard unit format, applied independently of the transaction amount. This represents the actual monetary value (e.g., 0.30 for $0.30 USD, 2.50 for €2.50 EUR). This fixed component is commonly used for per-transaction fees (e.g., $0.30 for card processing), account maintenance fees, or minimum transaction charges. When both rate and fixed_amount are present, the total fee equals (transaction_amount × rate / 10000) + fixed_amount.

  • payee
    Type: string

    To whom the fee is being paid.

  • payer
    Type: string

    Defines who is paying the fee. For example for fee of type processing_fee, the payer is payee.

  • rate
    Type: numberFormat: double

    Fee percentage of a charge amount in basis points. The actual value equals units / 100. For example, when units is 1, the actual value is 1 / 100 = 0.01 or when units is 10000, the actual value is 10000 / 100 = 100

  • rule
    Type: string

    Pricing rule information.