Fee Profiles

A fee_profiles represents a pricing scheme that automatically applies fees to each transaction. Changes to fee_profiles go into effect immediately.

Related Guides: Collecting Fees

List Fee Profiles

Retrieve a list of fee_profiles.

For details on how to query endpoints using the available parameters, see Query Parameters.

Request
query Parameters
after_cursor
string

Return every resource created after the cursor value.

Example: after_cursor=TRnasXQ5AmjsLnPMwnme7TL4
before_cursor
string

Return every resource created before the cursor value.

Example: before_cursor=TRnasXQ5AmjsLnPMwnme7TL4
limit
integer

The numbers of items to return.

Example: limit=10
header Parameters
Accept
string
Default: application/hal+json

Body Header

Responses
200

List of fee profiles

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

get/fee_profiles
Request samples 
curl "https://finix.sandbox-payments-api.com/fee_profiles" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/json
{
  • "_embedded": {
    • "fee_profiles": [
      ]
    },
  • "_links": {},
  • "page": {
    • "offset": 0,
    • "limit": 20,
    • "count": 2
    }
}

Create a Fee Profile

Create a fee_profile.

Request
Request Body schema: application/json
ach_basis_points
integer

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_fee
integer or null

A fixed amount in cents that will be charged to the merchant for processing an echeck (also called ACH payments) credit return.

ach_debit_return_fixed_fee
integer or null

A fixed amount in cents that will be charged to the merchant for processing an echeck (also called ACH payment) debit return.

ach_fixed_fee
integer

Fee in cents incurred for each individual Transfer.

american_express_assessment_basis_points
integer or null

Applies to gross American Express card volume.

american_express_basis_points
integer or null

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_interchange
boolean or null

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

american_express_fixed_fee
integer or null

Fee in cents incurred for each individual American Express Transfer.

american_express_externally_funded_basis_points
integer or null

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_fee
integer or null

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

ancillary_fixed_fee_primary
integer or null

An additional fixed fee that can be charged per Transfer.

ancillary_fixed_fee_secondary
integer or null

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

application
required
string

The ID of the Application associated with the Fee Profile.

basis_points
integer

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_points
integer or null

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_fee
integer or null

Fee in cents charged against every Transfer that includes non-US cards.

charge_interchange
boolean

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

diners_club_basis_points
integer or null

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_interchange
boolean or null

Set to True to incur interchange fees for Diners Transfers.

diners_club_fixed_fee
integer or null

Fee in cents incurred for each individual Diners Transfer.

discover_assessments_basis_points
integer or null

Assessment applies to gross Discover card transaction volume.

discover_basis_points
integer or null

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_interchange
boolean or null

Set to True to incur interchange fees for Discover Transfers.

discover_data_usage_fixed_fee
integer or null

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

discover_fixed_fee
integer or null

Fee in cents incurred for each individual Discover Transfer.

discover_externally_funded_basis_points
integer or null

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_fee
integer or null

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

discover_network_authorization_fixed_fee
integer or null

This fee applies to all Discover network authorizations and replaces the previously assessed Data Transmission.

dispute_fixed_fee
integer or null

Applied when a dispute is created or updated to a PENDING state.

dispute_inquiry_fixed_fee
integer or null

Applied when a dispute is created or updated to a INQUIRY state.

externally_funded_basis_points
integer or null

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

externally_funded_fixed_fee
integer or null

Fee in cents incurred for each individual Transfer that's card-based and externally funded.

fixed_fee
integer

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

jcb_basis_points
integer or null

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_interchange
boolean or null

Set to True to incur interchange fees for JCB Transfers.

jcb_fixed_fee
integer or null

Fee in cents incurred for each individual JCB Transfer.

mastercard_acquirer_fees_basis_points
integer or null

The fee is 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_points
integer or null

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

mastercard_assessments_under1k_basis_points
integer or null

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

mastercard_basis_points
integer or null

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_interchange
boolean or null

Set to True to incur interchange fees for MasterCard Transfers.

mastercard_fixed_fee
integer or null

Fee in cents incurred for each individual MasterCard Transfer.

qualified_tiers
object or null

The top of the qualified tier tree.

rounding_mode
string
  • Include AGGREGATE if you want to round after the settlement calculation.
  • By default, rounding happens before the sum of the settlement calculation (i.e. round each fee transfer)
Enum: "TRANSACTION" "AGGREGATE"
visa_acquirer_processing_fixed_fee
integer or null

Applied 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_points
integer or null

Applies to all Visa credit transactions.

visa_base_II_credit_voucher_fixed_fee
integer or null

Applies to all U.S.-based refunds.

visa_base_II_system_file_transmission_fixed_fee
integer or null

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

visa_basis_points
integer or null

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_interchange
boolean or null

Set to True to incur interchange fees for Visa Transfers.

visa_credit_voucher_fixed_fee
integer or null

Applies to Visa refunds.

visa_fixed_fee
integer or null

Fee in cents incurred for each individual Visa Transfer.

visa_kilobyte_access_fixed_fee
integer or null

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

Responses
201

Fee profile

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

422

Invalid field

post/fee_profiles
Request samples 
curl "https://finix.sandbox-payments-api.com/fee_profiles" \
  -H "Content-Type: application/json" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X POST \
  -d '
  {
    "ach_basis_points": 300,
    "ach_fixed_fee": 30,
    "application": "APmuwPBaW8pVcwb4vCTHQH32",
    "basis_points": 200,
    "card_cross_border_basis_points": 300,
    "card_cross_border_fixed_fee": 400,
    "charge_interchange": false,
    "fixed_fee": 100,
    "tags": {
      "app pricing": "sample"
    }
  }'
Response samples
application/json
{
  • "id": "FPq6PQ9pHsab66fKMmjQ7jb5",
  • "created_at": "2022-01-27T07:37:38.66Z",
  • "updated_at": "2022-01-27T07:37:38.66Z",
  • "ach_basis_points": 300,
  • "ach_credit_return_fixed_fee": null,
  • "ach_debit_return_fixed_fee": null,
  • "ach_fixed_fee": 30,
  • "american_express_assessment_basis_points": null,
  • "american_express_basis_points": null,
  • "american_express_charge_interchange": null,
  • "american_express_externally_funded_basis_points": null,
  • "american_express_externally_funded_fixed_fee": null,
  • "american_express_fixed_fee": null,
  • "ancillary_fixed_fee_primary": null,
  • "ancillary_fixed_fee_secondary": null,
  • "application": "APgPDQrLD52TYvqazjHJJchM",
  • "basis_points": 200,
  • "charge_interchange": false,
  • "diners_club_basis_points": null,
  • "diners_club_charge_interchange": null,
  • "diners_club_fixed_fee": null,
  • "discover_assessments_basis_points": null,
  • "discover_basis_points": null,
  • "discover_charge_interchange": null,
  • "discover_data_usage_fixed_fee": null,
  • "discover_externally_funded_basis_points": null,
  • "discover_externally_funded_fixed_fee": null,
  • "discover_fixed_fee": null,
  • "discover_network_authorization_fixed_fee": null,
  • "dispute_fixed_fee": null,
  • "dispute_inquiry_fixed_fee": null,
  • "externally_funded_basis_points": null,
  • "externally_funded_fixed_fee": null,
  • "fixed_fee": 100,
  • "jcb_basis_points": null,
  • "jcb_charge_interchange": null,
  • "jcb_fixed_fee": null,
  • "mastercard_acquirer_fees_basis_points": null,
  • "mastercard_assessments_over1k_basis_points": null,
  • "mastercard_assessments_under1k_basis_points": null,
  • "mastercard_basis_points": null,
  • "mastercard_charge_interchange": null,
  • "mastercard_fixed_fee": null,
  • "qualified_tiers": null,
  • "rounding_mode": "TRANSACTION",
  • "tags": { },
  • "visa_acquirer_processing_fixed_fee": null,
  • "visa_assessments_basis_points": null,
  • "visa_base_II_credit_voucher_fixed_fee": null,
  • "visa_base_II_system_file_transmission_fixed_fee": null,
  • "visa_basis_points": null,
  • "visa_charge_interchange": null,
  • "visa_credit_voucher_fixed_fee": null,
  • "visa_fixed_fee": null,
  • "visa_kilobyte_access_fixed_fee": null,
  • "_links": {}
}

Fetch a Fee Profile

Get a fee_profile.

Request
path Parameters
fee_profile_id
required
string

The ID of the fee_profile.

header Parameters
Accept
string
Default: application/hal+json
Responses
200

Fee profile

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/fee_profiles/{fee_profile_id}
Request samples 
curl "https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/json
{
  • "id": "FPq6PQ9pHsab66fKMmjQ7jb5",
  • "created_at": "2022-01-27T07:37:38.66Z",
  • "updated_at": "2022-01-27T07:37:38.66Z",
  • "ach_basis_points": 300,
  • "ach_credit_return_fixed_fee": null,
  • "ach_debit_return_fixed_fee": null,
  • "ach_fixed_fee": 30,
  • "american_express_assessment_basis_points": null,
  • "american_express_basis_points": null,
  • "american_express_charge_interchange": null,
  • "american_express_externally_funded_basis_points": null,
  • "american_express_externally_funded_fixed_fee": null,
  • "american_express_fixed_fee": null,
  • "ancillary_fixed_fee_primary": null,
  • "ancillary_fixed_fee_secondary": null,
  • "application": "APgPDQrLD52TYvqazjHJJchM",
  • "basis_points": 200,
  • "charge_interchange": false,
  • "diners_club_basis_points": null,
  • "diners_club_charge_interchange": null,
  • "diners_club_fixed_fee": null,
  • "discover_assessments_basis_points": null,
  • "discover_basis_points": null,
  • "discover_charge_interchange": null,
  • "discover_data_usage_fixed_fee": null,
  • "discover_externally_funded_basis_points": null,
  • "discover_externally_funded_fixed_fee": null,
  • "discover_fixed_fee": null,
  • "discover_network_authorization_fixed_fee": null,
  • "dispute_fixed_fee": null,
  • "dispute_inquiry_fixed_fee": null,
  • "externally_funded_basis_points": null,
  • "externally_funded_fixed_fee": null,
  • "fixed_fee": 100,
  • "jcb_basis_points": null,
  • "jcb_charge_interchange": null,
  • "jcb_fixed_fee": null,
  • "mastercard_acquirer_fees_basis_points": null,
  • "mastercard_assessments_over1k_basis_points": null,
  • "mastercard_assessments_under1k_basis_points": null,
  • "mastercard_basis_points": null,
  • "mastercard_charge_interchange": null,
  • "mastercard_fixed_fee": null,
  • "qualified_tiers": null,
  • "rounding_mode": "TRANSACTION",
  • "tags": { },
  • "visa_acquirer_processing_fixed_fee": null,
  • "visa_assessments_basis_points": null,
  • "visa_base_II_credit_voucher_fixed_fee": null,
  • "visa_base_II_system_file_transmission_fixed_fee": null,
  • "visa_basis_points": null,
  • "visa_charge_interchange": null,
  • "visa_credit_voucher_fixed_fee": null,
  • "visa_fixed_fee": null,
  • "visa_kilobyte_access_fixed_fee": null,
  • "_links": {}
}