FIfinix
Fees

Create a Custom Fee

Changed on

Create a custom (i.e. one-time) Fee.

post/fees

Request

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

amountinteger required

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

currency'CAD' | 'USD' required

ISO 4217 3-letter currency code.

display_namestring

The display name of the Fee that can be used for filtering purposes.

fee_subtype'CUSTOM' required

Subtype of the fee. Set to CUSTOM.

fee_type'CUSTOM' required

The type of the fee. Must be set to CUSTOM.

merchantstring required

The ID of the Merchant resource used to create the Fee.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Example request

{
  "amount": 5000
}

Response

Single Custom Fee object

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

amountnumber double

Represents the total amount. The value may be returned as either:

  • an integer (int32) in cents (e.g., 100 = $1.00), or
  • a double for fractional amounts (e.g., 2.393).
applicationstring

ID of the Application the resource was created under.

category'PROCESSOR' | 'INTERCHANGE' | 'DUES_AND_ASSESSMENTS' | 'THIRD_PARTY_SERVICE_PROVIDER' nullable

The Fee category.

currency'CAD' | 'USD'

ISO 4217 3-letter currency code.

display_namestring nullable

It is used for subscription fees and allows free-form text to be passed from the subscription fee product. Note that this product is mostly deprecated.

fee_profilestring nullable

The ID of the Fee Profile used to calculate fees for the Transfer related to this Fee. The specific Transfer is identified by the linked_to field.

fee_subtype'CUSTOM' | 'APPLICATION_FEE' | 'PLATFORM_FEE'

The subtype of the Fee.

fee_type'ACH_BASIS_POINTS' | 'ACH_CREDIT_RETURN_FIXED_FEE' | 'ACH_DEBIT_RETURN_FIXED_FEE' | 'ACH_FIXED' | 'ACH_MAX_FIXED' | 'ACH_NOTICE_OF_CHANGE_CREDIT_FIXED' | 'ACH_NOTICE_OF_CHANGE_DEBIT_FIXED' | 'ACH_VALIDATION_PLAID_FIXED' | 'AFTERPAY_BASIS_POINTS' | 'AFTERPAY_FIXED' | 'AMERICAN_EXPRESS_BASIS_POINTS' | 'AMERICAN_EXPRESS_EXTERNALLY_FUNDED_BASIS_POINTS' | 'AMERICAN_EXPRESS_EXTERNALLY_FUNDED_FIXED' | 'AMERICAN_EXPRESS_FIXED' | 'AMERICAN_EXPRESS_INTERCHANGE' | 'ANCILLARY_FIXED_FEE_PRIMARY' | 'ANCILLARY_FIXED_FEE_SECONDARY' | 'APPLICATION_FEE' | 'CARD_ACCOUNT_UPDATER_FIXED' | 'CARD_BASIS_POINTS' | 'CARD_CROSS_BORDER_BASIS_POINTS' | 'CARD_CROSS_BORDER_FIXED_FEE' | 'CARD_EXTERNALLY_FUNDED_BASIS_POINTS' | 'CARD_EXTERNALLY_FUNDED_FIXED' | 'CARD_FIXED' | 'CARD_INTERCHANGE' | 'CUSTOM' | 'CARD_NAME_VERIFICATION_FIXED' | 'CARD_NETWORK_TOKEN_FIXED' | 'CASH_APP_PAY_BASIS_POINTS' | 'CASH_APP_PAY_FIXED' | 'COMPLIANCE_FORM_OVERDUE_FIXED' | 'DINERS_CLUB_BASIS_POINTS' | 'DINERS_CLUB_FIXED' | 'DINERS_CLUB_INTERCHANGE' | 'DISCOVER_BASIS_POINTS' | 'DISCOVER_DATA_USAGE_FIXED' | 'DISCOVER_EXTERNALLY_FUNDED_BASIS_POINTS' | 'DISCOVER_EXTERNALLY_FUNDED_FIXED' | 'DISCOVER_FIXED' | 'DISCOVER_INTERCHANGE' | 'DISCOVER_NETWORK_AUTHORIZATION_FIXED' | 'DISPUTE_FIXED_FEE' | 'DISPUTE_INQUIRY_FIXED_FEE' | 'EFT_BASIS_POINTS' | 'EFT_CREDIT_RETURN_FIXED_FEE' | 'EFT_DEBIT_RETURN_FIXED_FEE' | 'EFT_FIXED' | 'EFT_MAX_FIXED' | 'EFT_VALIDATION_PLAID_FIXED' | 'GROSS_MONTHLY_FEES_ACH_BASIS_POINTS' | 'GROSS_MONTHLY_FEES_ACH_FIXED' | 'GROSS_MONTHLY_FEES_CARD_BASIS_POINTS' | 'GROSS_MONTHLY_FEES_CARD_FIXED' | 'GROSS_MONTHLY_FEES_EFT_BASIS_POINTS' | 'GROSS_MONTHLY_FEES_EFT_FIXED' | 'INTERAC_BASIS_POINTS' | 'INTERAC_FIXED' | 'INVOICE_ACH_BASIS_POINTS' | 'INVOICE_ACH_FIXED' | 'INVOICE_ACH_MAX_FIXED' | 'INVOICE_CARD_BASIS_POINTS' | 'INVOICE_CARD_FIXED' | 'INVOICE_EFT_BASIS_POINTS' | 'INVOICE_EFT_FIXED' | 'INVOICE_EFT_MAX_FIXED' | 'JCB_BASIS_POINTS' | 'JCB_FIXED' | 'JCB_INTERCHANGE' | 'MASTERCARD_ACQUIRER_FEE_BASIS_POINTS' | 'MASTERCARD_BASIS_POINTS' | 'MASTERCARD_FIXED' | 'MASTERCARD_INTERCHANGE' | 'QUALIFIED_TIER_BASIS_POINTS_FEE' | 'QUALIFIED_TIER_FIXED_FEE' | 'PAYMENT_INSTRUMENT_TOKENIZATION_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_ACH_BASIS_POINTS' | 'SETTLEMENT_FUNDING_TRANSFER_ACH_CREDIT_RETURN_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_ACH_DEBIT_RETURN_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_ACH_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_ACH_MAX_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_EFT_BASIS_POINTS' | 'SETTLEMENT_FUNDING_TRANSFER_EFT_CREDIT_RETURN_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_EFT_DEBIT_RETURN_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_EFT_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_EFT_MAX_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_BASIS_POINTS' | 'SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_MAX_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_NOC_CREDIT_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_NOC_DEBIT_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_BASIS_POINTS' | 'SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_FIXED' | 'SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_MAX_FIXED' | 'SUBSCRIPTION_ACH_BASIS_POINTS' | 'SUBSCRIPTION_ACH_FIXED' | 'SUBSCRIPTION_ACH_MAX_FIXED' | 'SUBSCRIPTION_CARD_BASIS_POINTS' | 'SUBSCRIPTION_CARD_FIXED' | 'SUBSCRIPTION_EFT_BASIS_POINTS' | 'SUBSCRIPTION_EFT_FIXED' | 'SUBSCRIPTION_EFT_MAX_FIXED' | 'SUPPLEMENTAL_FEE_FIXED' | 'THIRD_PARTY_GATEWAY_CYBERSOURCE_BASIS_POINTS' | 'THIRD_PARTY_GATEWAY_CYBERSOURCE_FIXED' | 'VISA_ACQUIRER_PROCESSING_FIXED' | 'VISA_BASE_II_CREDIT_VOUCHER_FIXED' | 'VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED' | 'VISA_BASIS_POINTS' | 'VISA_CREDIT_VOUCHER_FIXED' | 'VISA_FIXED' | 'VISA_INTERCHANGE' | 'VISA_KILOBYTE_ACCESS_FIXED'

The type of Fee. Finix may return more enums than those provided. Ensure your code accepts additional enums returned by Finix.

labelstring nullable

It is used for subscription fees and allows free-form text to be passed from the subscription fee product. Note that this product is mostly deprecated.

linked_idstring nullable

The ID of the linked resource. Note that this field will be deprecated soon, use linked_to instead.

linked_tostring nullable

The ID of the linked resource.

linked_type'TRANSFER' | 'AUTHORIZATION' | 'SPLIT_TRANSFER' nullable

The type of entity the Fee is linked to.

merchantstring

The ID of the Merchant resource that was charged the fee.

ready_to_settle_atstring date-time nullable

The timestamp indicating when the Transfer related to this Fee is ready to be settled. The specific Transfer is identified by the linked_to field.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Example response

{
  "amount": 2.393
}

Changes

  • 6e62a6816400Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      removed the AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS enum value from the response property for the response status

    • info

      removed the COMPLIANCE_FORMS_OVERDUE_FIXED enum value from the response property for the response status

    • info

      removed the DISCOVER_ASSESSMENT_BASIS_POINTS enum value from the response property for the response status

    • info

      removed the MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS enum value from the response property for the response status

    • info

      removed the MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS enum value from the response property for the response status

    • info

      removed the VISA_ASSESSMENT_BASIS_POINTS enum value from the response property for the response status

    • info

      removed the VISA_TRANSACTION_INTEGRITY_FIXED enum value from the response property for the response status

  • 9db82db717c5Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

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