v1

latestOpenAPI 3.0.22026-08-061303782.1 MB

Fee Profiles

Fetch a Fee Profile

Retrieve the details of an existing Fee Profile.

get/fee_profiles/{fee_profile_id}

Headers

Finix-Versionstring

Example:2022-02-01

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

Response

A single Fee Profile

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.

ach_basis_points_fee_limitinteger nullable

Maximum ACH basis points fee (in cents) incurred for each individual Transfer.

ach_basis_pointsinteger

Percentage-based fee incurred against the full amount of an eCheck (also called ACH payments). Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

ach_credit_return_fixed_feeinteger nullable

A fixed amount (in cents) that will be charged to the seller for receiving an ACH Credit Return.

ach_debit_return_fixed_feeinteger nullable

A fixed amount (in cents) that will be charged to the seller for receiving an ACH Debit Return.

ach_fixed_feeinteger

Fee in cents incurred for each individual Transfer.

ach_notice_of_change_credit_fixed_feeinteger nullable

The amount in cents charged as a fixed fee for processing ACH credit transactions that result in a Notice of Change (NOC).

ach_notice_of_change_debit_fixed_feeinteger nullable

Represents the fixed fee in cents for processing ACH debit transactions that generate a Notice of Change (NOC).

american_express_assessment_basis_pointsinteger nullable

Applies to gross American Express card volume.

american_express_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each American Express Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

american_express_charge_dues_assessmentsinteger nullable

A fee associated with American Express's assessment of dues or ongoing charges for services provided through the American Express payment network.

american_express_charge_interchangeinteger nullable

Set to true to incur interchange fees for American Express Transfers.

american_express_externally_funded_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each American Express externally funded Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

american_express_externally_funded_fixed_feeinteger nullable

Fee in cents incurred for each individual American Express externally funded Transfer.

american_express_fixed_feeinteger nullable

Fee in cents incurred for each individual American Express Transfer.

ancillary_fixed_fee_primaryinteger nullable

An additional fixed fee that can be charged per Transfer.

ancillary_fixed_fee_secondaryinteger nullable

An additional fixed fee that can be charged per Transfer if ancillary_fixed_fee_primary is included.

applicationstring

ID of the Application the resource was created under.

basis_pointsinteger

Percentage-based fee incurred against the full amount of each card-based Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

card_cross_border_basis_pointsinteger nullable

Percentage-based fee charged against the full amount of every Transfer that includes non-US cards. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

card_cross_border_fixed_feeinteger nullable

Fee in cents incurred for each individual American Express Transfer.

charge_dues_assessmentsboolean

Whether to pass the dues and assessment fees levied by all applicable card brands (e.g., American Express, Discover, Visa, Mastercard).

charge_interchangeboolean

Set to True to incur interchange fees for card-based Transfers.

compliance_forms_overdue_fixed_feeinteger nullable

Fee in cents charged for an overdue compliance form.

diners_club_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each Diners Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

diners_club_charge_interchangeboolean nullable

Set to true to incur interchange fees for Diners Transfers.

diners_club_fixed_feeinteger nullable

Fee in cents incurred for each individual Diners Transfer.

discover_assessments_basis_pointsinteger nullable

An assessment that applies to gross Discover card transaction volume.

discover_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each Discover Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

discover_charge_dues_assessmentsinteger nullable

A fee associated with Discover's assessment of dues or ongoing charges for services provided through the Discover payment network.

discover_charge_interchangeinteger nullable

Set to true to incur interchange fees for Discover Transfers.

discover_data_usage_fixed_feeinteger nullable

Applies to all U.S.-based authorization transactions.

discover_externally_funded_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each Discover externally funded Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

discover_externally_funded_fixed_feeinteger nullable

Fee in cents incurred for each individual Discover externally funded Transfer.

discover_fixed_feeinteger nullable

Fee in cents incurred for each individual Discover Transfer.

discover_network_authorization_fixed_feeinteger nullable

This fee will apply to all Discover network authorizations and will replace the previously assessed Data Transmission.

dispute_fixed_feeinteger nullable

Fee applied when a Dispute is created or updated to a PENDING state.

dispute_inquiry_fixed_feeinteger nullable

Fee applied when a Dispute is created or updated to a PENDING state.

eft_basis_points_fee_limitinteger nullable

The maximum percentage-based fee (in cents) incurred for each individual Transfer.

eft_basis_pointsinteger nullable

The percentage-based fee applied to the total amount of an EFT sale. Measured in basis points, where 1 basis point equals 0.01% (e.g., 100 basis points = 1%).

eft_credit_return_fixed_feeinteger nullable

A fixed fee (in cents) charged to the merchant for processing an EFT credit return.

eft_debit_return_fixed_feeinteger nullable

A fixed fee (in cents) charged to the seller for processing an EFT debit return.

eft_fixed_feeinteger nullable

A flat fee (in cents) incurred for each individual Transfer made from an EFT sale.

externally_funded_basis_pointsinteger nullable

The percentage-based fee applied to the total amount of each externally funded Transfer. Measured in basis points, where 1 basis point equals 0.01%.

externally_funded_fixed_feeinteger nullable

A fixed fee (in cents) incurred for each individual externally funded Transfer.

fixed_feeinteger nullable

Fee in cents incurred for each individual card-based Transfer.

gross_monthly_fees_ach_basis_pointsinteger nullable

The total amount of ACH (eCheck) basis point fees charged over a month.

gross_monthly_fees_ach_fixed_feeinteger nullable

The total amount of ACH (eCheck) fixed fees charged over a month.

gross_monthly_fees_card_basis_pointsinteger nullable

The total amount of card basis point fees charged over a month.

gross_monthly_fees_card_fixed_feeinteger nullable

The total amount of card fixed fees charged over a month.

gross_monthly_fees_eft_basis_pointsinteger nullable

The total amount of EFT basis point fees charged over a month.

gross_monthly_fees_eft_fixed_feeinteger nullable

The total amount of EFT fixed fees charged over a month.

interac_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each Interac Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

interac_fixed_feeinteger nullable

Fee in cents incurred for each individual Interac Transfer.

invoice_ach_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each ACH Transfer created when a buyer pays an Invoice. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

invoice_ach_basis_points_fee_limitinteger nullable

Maximum ACH basis points fee (in cents) incurred for each individual Transfer created when a buyer pays an Invoice.

invoice_ach_fixed_feeinteger nullable

A flat fee (in cents) incurred for each individual ACH Transfer created when a buyer pays an Invoice.

invoice_card_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each card-based Transfer created when a buyer pays an Invoice. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

invoice_card_fixed_feeinteger nullable

A flat fee (in cents) incurred for each individual card-based Transfer created when a buyer pays an Invoice.

invoice_eft_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each EFT Transfer created when a buyer pays an Invoice. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

invoice_eft_basis_points_fee_limitinteger nullable

Maximum EFT basis points fee (in cents) incurred for each individual Transfer created when a buyer pays an Invoice.

invoice_eft_fixed_feeinteger nullable

A flat fee (in cents) incurred for each individual EFT Transfer created when a buyer pays an Invoice.

jcb_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each JCB Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

jcb_charge_interchangeinteger nullable

Set to true to incur interchange fees for JCB Transfers.

jcb_fixed_feeinteger nullable

Fee in cents incurred for each individual JCB Transfer.

mastercard_acquirer_fees_basis_pointsinteger nullable

A fee assessed on a business’s gross MasterCard processing volume. This fee varies per acquirer based on MasterCard’s assessed charge as it’s distributed across the acquirer’s portfolio of merchants. Generally, this fee is a fraction of a basis point. For example, 0.0045%, 0.0075%, etc. are examples of a likely fee.

mastercard_assessments_over1k_basis_pointsinteger nullable

Fee applied to Mastercard credit sale transactions greater than $1,000.

mastercard_assessments_under1k_basis_pointsinteger nullable

Fee applied to Mastercard transactions less than or equal to $1,000.

mastercard_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each MasterCard Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

mastercard_charge_dues_assessmentsinteger nullable

A fee associated with MasterCard's assessment of dues or ongoing charges for services provided through the MasterCard payment network.

mastercard_charge_interchangeboolean nullable

Set to true to incur interchange fees for MasterCard Transfers.

mastercard_fixed_feeinteger nullable

Fee in cents incurred for each individual MasterCard Transfer.

payment_instrument_tokenization_fixed_feeinteger nullable

A fee in cents charged when Finix tokenizes a Payment Instrument.

qualified_tiersobject nullable

The top of the qualified tier tree.

rounding_mode'TRANSACTION' | 'AGGREGATE'

Set to AGGREGATE to round after the settlement calculation. By default, rounding happens before the sum of the settlement calculation (i.e., round each fee transfer).

settlement_funding_transfer_ach_basis_points_fee_limitinteger nullable

The maximum percentage-based fee (in cents) incurred for each individual Settlement Funding Transfer (ACH).

settlement_funding_transfer_ach_basis_pointsinteger nullable

A percentage-based fee applied to ACH transfers related to settlement funding. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

settlement_funding_transfer_ach_credit_return_fixed_feeinteger nullable

A fixed fee (in cents) charged to the platform or seller when receiving a credit return related to a Settlement Funding Transfer (ACH).

settlement_funding_transfer_ach_debit_return_fixed_feeinteger nullable

A fixed fee (in cents) charged to the platform or seller when receiving a Debit Return related to a Settlement Funding Transfer (ACH).

settlement_funding_transfer_ach_fixed_feeinteger nullable

A flat fee (in cents) incurred for each individual Settlement Funding Transfer (ACH).

settlement_funding_transfer_eft_basis_points_fee_limitinteger nullable

The maximum percentage-based fee (in cents) incurred for each individual settlement funding Transfer made via an EFT.

settlement_funding_transfer_eft_basis_pointsinteger nullable

The percentage-based fee applied to the total amount of a settlement funding Transfer made via an EFT from a Canadian-based bank account. Measured in basis points, where 1 basis point equals 0.01% (e.g., 100 basis points = 1%).

settlement_funding_transfer_eft_credit_return_fixed_feeinteger nullable

A fixed fee (in cents) charged for processing a Credit Return related to a settlement funding Transfer. This occurs when funds are returned from a Canadian-based bank account back to the seller's account via EFT.

settlement_funding_transfer_eft_debit_return_fixed_feeinteger nullable

A fixed fee (in cents) charged for processing a Debit Return related to a settlement funding Transfer. This occurs when funds are returned from the seller's account to a Canadian-based bank account via EFT due to a payment failure or reversal.

settlement_funding_transfer_eft_fixed_feeinteger nullable

A flat fee (in cents) incurred for each settlement funding Transfer made via an EFT from a Canadian-based bank account. This fee is independent of the payment amount.

settlement_funding_transfer_instant_payout_card_basis_points_fee_limitinteger nullable

The maximum percentage-based fee (in cents) incurred for each individual settlement funding Transfer made as an instant payout to a card.

settlement_funding_transfer_instant_payout_card_basis_pointsinteger nullable

The percentage-based fee applied to the total amount of a settlement funding Transfer made as an instant payout to a card. Measured in basis points, where 1 basis point equals 0.01% (e.g., 100 basis points = 1%).

settlement_funding_transfer_instant_payout_card_fixed_feeinteger nullable

A flat fee (in cents) incurred for each settlement funding Transfer made as an instant payout to a card.

settlement_funding_transfer_noc_credit_fixed_feeinteger nullable

A fixed fee (in cents) charged for processing a Notification of Change (NOC) related to a credit transaction in settlement funding transfers.

settlement_funding_transfer_noc_debit_fixed_feeinteger nullable

A fixed fee (in cents) charged for processing a Notification of Change (NOC) related to a debit transaction in settlement funding transfers.

settlement_funding_transfer_same_day_ach_basis_points_fee_limitinteger nullable

The maximum percentage-based fee (in cents) incurred for each individual Settlement Funding Transfer (ACH).

settlement_funding_transfer_same_day_ach_basis_pointsinteger nullable

A percentage-based fee applied to ACH transfers related to settlement funding. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

settlement_funding_transfer_same_day_ach_fixed_feeinteger nullable

A flat fee (in cents) incurred for each settlement funding Transfer made via same-day ACH.

subscription_ach_basis_pointsinteger nullable

The percentage-based fee incurred against the full amount of each ACH Direct Debit transaction created from a Subscription. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

subscription_ach_basis_points_fee_limitinteger nullable

The maximum subscription_ach_basis_points fee (in cents) incurred for each individual Transfer created from a Subscription.

subscription_ach_fixed_feeinteger nullable

The fee in cents incurred for each individual ACH Direct Debit transaction created from a Subscription.

subscription_card_basis_pointsinteger nullable

The percentage-based fee incurred against the full amount of each card-based transaction created from a Subscription. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

subscription_card_fixed_feeinteger nullable

The percentage-based fee incurred against the full amount of each EFT transaction created from a Subscription. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

subscription_eft_basis_pointsinteger nullable

The percentage-based fee incurred against the full amount of each EFT transaction created from a Subscription. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).

subscription_eft_basis_points_fee_limitinteger nullable

The maximum subscription_eft_basis_points fee (in cents) incurred for each individual Transfer created from a Subscription.

subscription_eft_fixed_feeinteger nullable

The fee in cents incurred for each individual EFT transaction created from a Subscription.

visa_acquirer_processing_fixed_feeinteger nullable

Applies to all U.S.-based credit card authorizations acquired in the U.S., regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee will apply to all Visa credit card authorizations.

visa_assessments_basis_pointsinteger nullable

visa_base_II_credit_voucher_fixed_feeinteger nullable

Applies to all U.S.-based refunds.

visa_base_II_system_file_transmission_fixed_feeinteger nullable

Applies to all Visa transactions and is charged in addition to other transaction-based assessments.

visa_basis_pointsinteger nullable

Percentage-based fee incurred against the full amount of each Visa Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)

visa_charge_dues_assessmentsinteger nullable

A fee associated with Visa's assessment of dues or ongoing charges for services provided through the Visa payment network.

visa_charge_interchangeboolean nullable

Set to true to incur interchange fees for Visa Transfers.

visa_credit_voucher_fixed_feeinteger nullable

Applies to Visa refunds.

visa_fixed_feeinteger nullable

Fee in cents incurred for each individual Visa Transfer.

visa_kilobyte_access_fixed_feeinteger nullable

Charged on each authorization transaction submitted to Visa’s network for settlement.

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)