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: Managing Fee Profiles

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
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 USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
Response samples
application/json
{
  • "_embedded": {
    • "fee_profiles": [
      ]
    },
  • "_links": {},
  • "page": {
    • "limit": 100,
    • "next_cursor": "FP9F2KEnY4wt1XjFvhLBJVjb"
    }
}

Create a Fee Profile

Create a fee_profile.

Request
Request Body schema: application/json
One of:
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_fixed_fee
integer

Fee in cents incurred for each individual 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.

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.

fixed_fee
integer

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

rounding_mode
string

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).

Enum: "TRANSACTION" "AGGREGATE"
Responses
201

Fee profile

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

422

Invalid field

post/fee_profiles
Request samples 
Response samples 
application/json
{
  • "id": "FPvCQUcnsueN3Bc3zR1qCBG8",
  • "created_at": "2022-01-27T07:37:36.69Z",
  • "updated_at": "2022-01-27T07:37:36.69Z",
  • "ach_basis_points": 300,
  • "ach_basis_points_fee_limit": null,
  • "ach_credit_return_fixed_fee": null,
  • "ach_debit_return_fixed_fee": null,
  • "ach_fixed_fee": 30,
  • "ach_notice_of_change_credit_fixed_fee": null,
  • "ach_notice_of_change_debit_fixed_fee": null,
  • "american_express_assessment_basis_points": null,
  • "american_express_basis_points": null,
  • "american_express_charge_dues_assessments": 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_dues_assessments": null,
  • "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_dues_assessments": 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,
  • "eft_basis_points": null,
  • "eft_basis_points_fee_limit": null,
  • "eft_credit_return_fixed_fee": null,
  • "eft_debit_return_fixed_fee": null,
  • "eft_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_dues_assessments": null,
  • "mastercard_charge_interchange": null,
  • "mastercard_fixed_fee": null,
  • "qualified_tiers": null,
  • "rounding_mode": "TRANSACTION",
  • "settlement_funding_transfer_ach_basis_points": null,
  • "settlement_funding_transfer_ach_basis_points_fee_limit": null,
  • "settlement_funding_transfer_ach_credit_return_fixed_fee": null,
  • "settlement_funding_transfer_ach_debit_return_fixed_fee": null,
  • "settlement_funding_transfer_ach_fixed_fee": null,
  • "settlement_funding_transfer_eft_basis_points": null,
  • "settlement_funding_transfer_eft_basis_points_fee_limit": null,
  • "settlement_funding_transfer_eft_credit_return_fixed_fee": null,
  • "settlement_funding_transfer_eft_debit_return_fixed_fee": null,
  • "settlement_funding_transfer_eft_fixed_fee": null,
  • "settlement_funding_transfer_instant_payout_card_basis_points": null,
  • "settlement_funding_transfer_instant_payout_card_basis_points_fee_limit": null,
  • "settlement_funding_transfer_instant_payout_card_fixed_fee": null,
  • "settlement_funding_transfer_noc_credit_fixed_fee": null,
  • "settlement_funding_transfer_noc_debit_fixed_fee": null,
  • "settlement_funding_transfer_same_day_ach_basis_points": null,
  • "settlement_funding_transfer_same_day_ach_basis_points_fee_limit": null,
  • "settlement_funding_transfer_same_day_ach_fixed_fee": null,
  • "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_dues_assessments": 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.


 
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/FPuizPqrhzYLbmJm88u7aqfj" \
  -H "Finix-Version: 2022-02-01" \
  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
Response samples 
application/json
{
  • "id": "FPvCQUcnsueN3Bc3zR1qCBG8",
  • "created_at": "2022-01-27T07:37:36.69Z",
  • "updated_at": "2022-01-27T07:37:36.69Z",
  • "ach_basis_points": 300,
  • "ach_basis_points_fee_limit": null,
  • "ach_credit_return_fixed_fee": null,
  • "ach_debit_return_fixed_fee": null,
  • "ach_fixed_fee": 30,
  • "ach_notice_of_change_credit_fixed_fee": null,
  • "ach_notice_of_change_debit_fixed_fee": null,
  • "american_express_assessment_basis_points": null,
  • "american_express_basis_points": null,
  • "american_express_charge_dues_assessments": 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_dues_assessments": null,
  • "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_dues_assessments": 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,
  • "eft_basis_points": null,
  • "eft_basis_points_fee_limit": null,
  • "eft_credit_return_fixed_fee": null,
  • "eft_debit_return_fixed_fee": null,
  • "eft_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_dues_assessments": null,
  • "mastercard_charge_interchange": null,
  • "mastercard_fixed_fee": null,
  • "qualified_tiers": null,
  • "rounding_mode": "TRANSACTION",
  • "settlement_funding_transfer_ach_basis_points": null,
  • "settlement_funding_transfer_ach_basis_points_fee_limit": null,
  • "settlement_funding_transfer_ach_credit_return_fixed_fee": null,
  • "settlement_funding_transfer_ach_debit_return_fixed_fee": null,
  • "settlement_funding_transfer_ach_fixed_fee": null,
  • "settlement_funding_transfer_eft_basis_points": null,
  • "settlement_funding_transfer_eft_basis_points_fee_limit": null,
  • "settlement_funding_transfer_eft_credit_return_fixed_fee": null,
  • "settlement_funding_transfer_eft_debit_return_fixed_fee": null,
  • "settlement_funding_transfer_eft_fixed_fee": null,
  • "settlement_funding_transfer_instant_payout_card_basis_points": null,
  • "settlement_funding_transfer_instant_payout_card_basis_points_fee_limit": null,
  • "settlement_funding_transfer_instant_payout_card_fixed_fee": null,
  • "settlement_funding_transfer_noc_credit_fixed_fee": null,
  • "settlement_funding_transfer_noc_debit_fixed_fee": null,
  • "settlement_funding_transfer_same_day_ach_basis_points": null,
  • "settlement_funding_transfer_same_day_ach_basis_points_fee_limit": null,
  • "settlement_funding_transfer_same_day_ach_fixed_fee": null,
  • "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_dues_assessments": null,
  • "visa_charge_interchange": null,
  • "visa_credit_voucher_fixed_fee": null,
  • "visa_fixed_fee": null,
  • "visa_kilobyte_access_fixed_fee": null,
  • "_links": {}
}