Fees

fees are a charge placed against a Merchant and show up as part of Settlements.

fees get generated while payments are processed but can also get created from subscription billing.

List Fees

Return a collection of fees.

Request
query Parameters
limit
integer

The numbers of items to return.

Example: limit=10
offset
integer

The number of items to skip before starting to collect the result set.

Example: offset=20
Responses
200

List of Fee objects

Response Schema: application/hal+json
object
object

List of fee objects.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

get/fees
Request samples
curl https://finix.sandbox-payments-api.com/fees \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Create a One-Time Fee

Create a custom (i.e. one time) fee.

Request
Request Body schema: application/hal+json
amount
required
integer <int64>

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

currency
required
string

ISO 4217 3 letter currency code.

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"
fee_subtype
required
string

Subtype of the fee. Set to CUSTOM.

Value: "CUSTOM"
fee_type
required
string

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

Value: "CUSTOM"
label
string

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

linked_id
string

ID of the linked resource

linked_type
string

The type of entity the fee is linked to (null by default).

Enum: "APPLICATION" "PLATFORM" "SUBSCRIPTION" "TRANSFER"
merchant_id
required
string

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

settlement_delay_days
integer or null

Delays in days, when the fee will be submitted for settlement.

object

Key value pair for annotating custom meta data (e.g. order numbers).

Responses
201

Single Fee object

Response Schema: application/hal+json
id
string

The ID of the fee resource.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

amount
integer

The amount of the fee in cents.

currency
string

ISO 4217 3 letter currency code.

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"
display_name
string or null

The name of the fee object that was include in display_name when creating the fee.

fee_subtype
string

Subtype of the fee.

Enum: "CUSTOM" "APPLICATION_FEE" "PLATFORM_FEE"
fee_type
string

The type of fee.

Enum: "APPLICATION_FEE" "ACH_BASIS_POINTS" "ACH_FIXED" "CARD_BASIS_POINTS" "CARD_FIXED" "CARD_INTERCHANGE" "VISA_BASIS_POINTS" "VISA_FIXED" "VISA_INTERCHANGE" "VISA_ASSESSMENT_BASIS_POINTS" "VISA_ACQUIRER_PROCESSING_FIXED" "VISA_CREDIT_VOUCHER_FIXED" "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED" "VISA_BASE_II_CREDIT_VOUCHER_FIXED" "VISA_KILOBYTE_ACCESS_FIXED" "DISCOVER_BASIS_POINTS" "DISCOVER_FIXED" "DISCOVER_INTERCHANGE" "DISCOVER_ASSESSMENT_BASIS_POINTS" "DISCOVER_DATA_USAGE_FIXED" "DISCOVER_NETWORK_AUTHORIZATION_FIXED" "DINERS_CLUB_BASIS_POINTS" "DINERS_CLUB_FIXED" "DINERS_CLUB_INTERCHANGE" "MASTERCARD_BASIS_POINTS" "MASTERCARD_FIXED" "MASTERCARD_INTERCHANGE" "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS" "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS" "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS" "JCB_BASIS_POINTS" "JCB_FIXED" "JCB_INTERCHANGE" "AMERICAN_EXPRESS_BASIS_POINTS" "AMERICAN_EXPRESS_FIXED" "AMERICAN_EXPRESS_INTERCHANGE" "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS" "DISPUTE_INQUIRY_FIXED_FEE" "DISPUTE_FIXED_FEE" "QUALIFIED_TIER_BASIS_POINTS_FEE" "QUALIFIED_TIER_FIXED_FEE" "CUSTOM" "ACH_DEBIT_RETURN_FIXED_FEE" "ACH_CREDIT_RETURN_FIXED_FEE" "ANCILLARY_FIXED_FEE_PRIMARY" "ANCILLARY_FIXED_FEE_SECONDARY" "SETTLEMENT_V2_TRANSFER"
label
string or null

The name of the fee object that was include in label when creating the fee.

linked_id
string

ID of the linked resource.

linked_type
string

The type of entity the fee is linked to (null by default).

Enum: "APPLICATION" "PLATFORM" "SUBSCRIPTION" "TRANSFER"
merchant
string

The Merchant ID that the fee is being debited from.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

post/fees
Request samples
Response samples
application/hal+json
{}

Fetch a Fee

Retrieve the details of a fee.

Request
path Parameters
fee_id
required
string

ID of fee to use.

Responses
200

Single Fee object

Response Schema: application/hal+json
id
string

The ID of the fee resource.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

amount
integer

The amount of the fee in cents.

currency
string

ISO 4217 3 letter currency code.

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"
display_name
string or null

The name of the fee object that was include in display_name when creating the fee.

fee_subtype
string

Subtype of the fee.

Enum: "CUSTOM" "APPLICATION_FEE" "PLATFORM_FEE"
fee_type
string

The type of fee.

Enum: "APPLICATION_FEE" "ACH_BASIS_POINTS" "ACH_FIXED" "CARD_BASIS_POINTS" "CARD_FIXED" "CARD_INTERCHANGE" "VISA_BASIS_POINTS" "VISA_FIXED" "VISA_INTERCHANGE" "VISA_ASSESSMENT_BASIS_POINTS" "VISA_ACQUIRER_PROCESSING_FIXED" "VISA_CREDIT_VOUCHER_FIXED" "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED" "VISA_BASE_II_CREDIT_VOUCHER_FIXED" "VISA_KILOBYTE_ACCESS_FIXED" "DISCOVER_BASIS_POINTS" "DISCOVER_FIXED" "DISCOVER_INTERCHANGE" "DISCOVER_ASSESSMENT_BASIS_POINTS" "DISCOVER_DATA_USAGE_FIXED" "DISCOVER_NETWORK_AUTHORIZATION_FIXED" "DINERS_CLUB_BASIS_POINTS" "DINERS_CLUB_FIXED" "DINERS_CLUB_INTERCHANGE" "MASTERCARD_BASIS_POINTS" "MASTERCARD_FIXED" "MASTERCARD_INTERCHANGE" "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS" "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS" "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS" "JCB_BASIS_POINTS" "JCB_FIXED" "JCB_INTERCHANGE" "AMERICAN_EXPRESS_BASIS_POINTS" "AMERICAN_EXPRESS_FIXED" "AMERICAN_EXPRESS_INTERCHANGE" "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS" "DISPUTE_INQUIRY_FIXED_FEE" "DISPUTE_FIXED_FEE" "QUALIFIED_TIER_BASIS_POINTS_FEE" "QUALIFIED_TIER_FIXED_FEE" "CUSTOM" "ACH_DEBIT_RETURN_FIXED_FEE" "ACH_CREDIT_RETURN_FIXED_FEE" "ANCILLARY_FIXED_FEE_PRIMARY" "ANCILLARY_FIXED_FEE_SECONDARY" "SETTLEMENT_V2_TRANSFER"
label
string or null

The name of the fee object that was include in label when creating the fee.

linked_id
string

ID of the linked resource.

linked_type
string

The type of entity the fee is linked to (null by default).

Enum: "APPLICATION" "PLATFORM" "SUBSCRIPTION" "TRANSFER"
merchant
string

The Merchant ID that the fee is being debited from.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/fees/{fee_id}
Request samples
curl https://finix.sandbox-payments-api.com/fees/FEtSD9oNjoCtJaN2C1FwhZ29 \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Update Fee

Update the details of a fee.

Request
path Parameters
fee_id
required
string

ID of fee to use.

Request Body schema: application/hal+json
tags
object or null

Key value pair for annotating custom meta data (e.g. order numbers).

Responses
200

Single Fee object

Response Schema: application/hal+json
id
string

The ID of the fee resource.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

amount
integer

The amount of the fee in cents.

currency
string

ISO 4217 3 letter currency code.

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"
display_name
string or null

The name of the fee object that was include in display_name when creating the fee.

fee_subtype
string

Subtype of the fee.

Enum: "CUSTOM" "APPLICATION_FEE" "PLATFORM_FEE"
fee_type
string

The type of fee.

Enum: "APPLICATION_FEE" "ACH_BASIS_POINTS" "ACH_FIXED" "CARD_BASIS_POINTS" "CARD_FIXED" "CARD_INTERCHANGE" "VISA_BASIS_POINTS" "VISA_FIXED" "VISA_INTERCHANGE" "VISA_ASSESSMENT_BASIS_POINTS" "VISA_ACQUIRER_PROCESSING_FIXED" "VISA_CREDIT_VOUCHER_FIXED" "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED" "VISA_BASE_II_CREDIT_VOUCHER_FIXED" "VISA_KILOBYTE_ACCESS_FIXED" "DISCOVER_BASIS_POINTS" "DISCOVER_FIXED" "DISCOVER_INTERCHANGE" "DISCOVER_ASSESSMENT_BASIS_POINTS" "DISCOVER_DATA_USAGE_FIXED" "DISCOVER_NETWORK_AUTHORIZATION_FIXED" "DINERS_CLUB_BASIS_POINTS" "DINERS_CLUB_FIXED" "DINERS_CLUB_INTERCHANGE" "MASTERCARD_BASIS_POINTS" "MASTERCARD_FIXED" "MASTERCARD_INTERCHANGE" "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS" "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS" "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS" "JCB_BASIS_POINTS" "JCB_FIXED" "JCB_INTERCHANGE" "AMERICAN_EXPRESS_BASIS_POINTS" "AMERICAN_EXPRESS_FIXED" "AMERICAN_EXPRESS_INTERCHANGE" "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS" "DISPUTE_INQUIRY_FIXED_FEE" "DISPUTE_FIXED_FEE" "QUALIFIED_TIER_BASIS_POINTS_FEE" "QUALIFIED_TIER_FIXED_FEE" "CUSTOM" "ACH_DEBIT_RETURN_FIXED_FEE" "ACH_CREDIT_RETURN_FIXED_FEE" "ANCILLARY_FIXED_FEE_PRIMARY" "ANCILLARY_FIXED_FEE_SECONDARY" "SETTLEMENT_V2_TRANSFER"
label
string or null

The name of the fee object that was include in label when creating the fee.

linked_id
string

ID of the linked resource.

linked_type
string

The type of entity the fee is linked to (null by default).

Enum: "APPLICATION" "PLATFORM" "SUBSCRIPTION" "TRANSFER"
merchant
string

The Merchant ID that the fee is being debited from.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

put/fees/{fee_id}
Request samples
Response samples
application/hal+json
{}