Sign in
Fee markups

Create fee markup

Create or update a fee markup for a company. If a markup for the specified fee type already exists, it will be updated with the new values.

Required permissions:

  • company:update_child_fees
post/fee_markups

Request body

account_idstring required

The unique identifier of the company to create or update the fee markup for.

fee_type'crypto_withdrawal_markup' | 'rtp_withdrawal_markup' | 'next_day_bank_withdrawal_markup' | 'bank_wire_withdrawal_markup' | 'digital_wallet_withdrawal_markup' | 'transfer_markup' | 'crypto_deposit_markup' | 'bank_deposit_markup' | 'crypto_swap_markup' | 'payment_markup' required

The types of fee markups that can be configured

fixed_fee_usdnumber nullable

The fixed fee amount in USD to charge per transaction. Must be between 0 and 50.

metadataobject nullable

Custom key-value metadata to attach to this fee markup.

notesstring nullable

Internal notes about this fee markup for record-keeping purposes.

percentage_feenumber nullable

The percentage fee to charge per transaction. Must be between 0 and 25.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "fixed_fee_usd": 6.9,
  "percentage_fee": 6.9
}

Response

A successful response

created_atstring date-time required

The datetime the fee markup was created.

fee_type'crypto_withdrawal_markup' | 'rtp_withdrawal_markup' | 'next_day_bank_withdrawal_markup' | 'bank_wire_withdrawal_markup' | 'digital_wallet_withdrawal_markup' | 'transfer_markup' | 'crypto_deposit_markup' | 'bank_deposit_markup' | 'crypto_swap_markup' | 'payment_markup' required

The types of fee markups that can be configured

fixed_fee_usdnumber nullable required

A flat fee charged per transaction, in USD. Ranges from 0 to 50. Null if no fixed fee is configured.

idstring required

The unique identifier for the fee markup.

notesstring nullable required

Internal notes about this fee markup, visible only to administrators. Null if no notes have been added.

percentage_feenumber nullable required

A percentage-based fee charged per transaction. Ranges from 0 to 25. Null if no percentage fee is configured.

updated_atstring date-time required

The datetime the fee markup was last updated.

Example response

{
  "created_at": "2023-12-01T05:00:00.401Z",
  "fixed_fee_usd": 6.9,
  "notes": "Approved by finance team on 2024-01-15",
  "percentage_fee": 6.9,
  "updated_at": "2023-12-01T05:00:00.401Z"
}

Changes

Changed in 4 of the 74 revisions of this API.163

  • 14e4732f295d11See the full diff
    • ●

      added the new payment_markup enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new payment_markup enum value to the request property

      request-property-enum-value-added

  • 918ff9d965e12See the full diff
    • ●

      added the new crypto_swap_markup enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new transfer_markup enum value to the response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4fe3b2d2154622See the full diff
    • ●

      added the new bank_deposit_markup enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new crypto_deposit_markup enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new bank_deposit_markup enum value to the request property

      request-property-enum-value-added

    • ○

      added the new crypto_deposit_markup enum value to the request property

      request-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 697924df40d111See the full diff
    • ▲

      added the new required request property

      new-required-request-property

    • ●

      removed the request property

      request-property-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.