← Tools Reference

Fern

Fern integration (Finance). Imported from open-connector.

API key7 toolshttps://api.fernhq.com
GET
fern_list_customers
List Fern customers with optional organization filtering and cursor pagination.

/customers

3 parameters
ParamTypeRequiredDescription
pageTokenstringoptionalToken for forward pagination.
pageSizeintegeroptionalNumber of items per page, from 1 to 100.
organizationIdstringoptionalOrganization ID to filter customers.
GET
fern_get_customer
Retrieve one Fern customer by ID.

/customers/{customerId}

3 parameters
ParamTypeRequiredDescription
customerIdstringrequiredUnique identifier of the customer.
includeVerificationbooleanoptionalWhether to include verification details.
includePaymentMethodsbooleanoptionalWhether to include available payment methods in the response.
GET
fern_list_payment_accounts
List Fern payment accounts for a customer with cursor pagination.

/payment-accounts

3 parameters
ParamTypeRequiredDescription
customerIdstringrequiredCustomer to list payment accounts for.
pageTokenstringoptionalToken for forward pagination.
pageSizeintegeroptionalNumber of items per page, from 1 to 100.
GET
fern_get_payment_account
Retrieve one Fern payment account by ID.

/payment-accounts/{paymentAccountId}

1 parameter
ParamTypeRequiredDescription
paymentAccountIdstringrequiredUnique identifier of the payment account.
GET
fern_get_exchange_rate
Retrieve Fern exchange rate and fee details for source and destination currencies.

/exchange-rates

5 parameters
ParamTypeRequiredDescription
sourceCurrencystringrequiredCurrency label or contract address for the source currency.
sourcePaymentMethodstringrequiredPayment method for the source exchange rate.
sourceAmountstringoptionalAmount to be sent. When provided, Fern returns fees and destination amount.
destinationPaymentMethodstringrequiredPayment method for the destination exchange rate.
destinationCurrencystringrequiredCurrency label or contract address for the destination currency.
GET
fern_list_transactions
List Fern transactions with optional customer, payment account, and organization filters.

/transactions

5 parameters
ParamTypeRequiredDescription
pageTokenstringoptionalToken for forward pagination.
pageSizeintegeroptionalNumber of items per page, from 1 to 100.
customerIdstringoptionalCustomer to list transactions for.
paymentAccountIdstringoptionalPayment account to list transactions for.
organizationIdstringoptionalOrganization to list transactions for.
GET
fern_get_transaction
Retrieve one Fern transaction by ID.

/transactions/{transactionId}

1 parameter
ParamTypeRequiredDescription
transactionIdstringrequiredUnique identifier of the transaction.