Skip to main content
GET
/
fees
Calculate Fees
curl --request GET \
  --url https://api.guile.app/fees \
  --header 'Authorization: Bearer <token>'
{
  "grossAmount": "456.78",
  "fee": "456.78",
  "netAmount": "456.78",
  "type": "instantPayout"
}

Query Parameters

​
amount
string<decimal>
required

The amount of money to calculate the fee for. A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision.

Example:

"456.78"

​
type
enum<string>
required

The type of fee to calculate. The available types of fee calculations.

Available options:
instantPayout,
appointment
​
appointment
string<uuid>

The appointment context for fee calculations. This is required when type is appointment. The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Response

Ok. The operation succeeded.

The calculated fees for the given monetary amount.

​
grossAmount
string<decimal>
required

The original amount of money for fee calculations.

Example:

"456.78"

​
fee
string<decimal>
required

The calcualted fee for the given money amount.

Example:

"456.78"

​
netAmount
string<decimal>
required

The net amount of money after applied fees.

Example:

"456.78"

​
type
enum<string>
required

The calculation's fee type.

Available options:
instantPayout,
appointment