Fees

A Fee is a charge levied against a Merchant. It represents how a platform charges its sellers for all various types of Fees. Payment transactions generate Fee resources.

List Fees

Retrieve a list of Fee resources. As a query parameter, pass the ID of the TRANSFER or AUTHORIZATION that generated the Fee.

Request
query Parameters
linked_to
string

The ID of the TRANSFER or AUTHORIZATION that generated the Fee.

Example: linked_to=TRvypRNBeqM597Zi4DcqJ2Vh
limit
integer

The numbers of items to return.

Example: limit=10
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
created_at.gte
string <date-time>

Filter where created_at is after the given date.

Example: created_at.gte=2022-09-27T11:21:23
created_at.lte
string <date-time>

Filter where created_at is before the given date.

Example: created_at.lte=2022-09-27T11:21:23
header Parameters
Finix-Version
string
Default: 2018-01-01

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

Example: 2022-02-01
Responses
200

List of Fee objects

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

get/fees
Request samples 
curl "https://finix.sandbox-payments-api.com/fees?linked_id=TRfnif8f9U1r6k2zys27U4yP" \
  -H "Finix-Version: 2022-02-01" \
  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
Response samples
application/json
{}

Create a Fee

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

Request
header Parameters
Finix-Version
string
Default: 2018-01-01

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

Example: 2022-02-01
Request Body schema: application/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" … 174 more
display_name
string

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

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"
merchant
required
string

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

object or null

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)
Responses
201

Single Fee object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

post/fees
Request samples 
Response samples 
application/json
{}
Fetch a Fee
Retrieve the details of a Fee.


Request 
path Parameters
fee_id
required
string
The ID of the Fee.


 
header Parameters
Finix-Version
string
 Default:  2018-01-01
Specify the API version of your request. For more details, see Versioning.


 
 Example:  2022-02-01
Responses 
200
Single Fee object


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/FEvjF5iPwy6zuUEsBWgJ9T79" \
  -H "Finix-Version: 2022-02-01" \
  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
Response samples 
application/json
{}