How-to: Configure your integrator fee

The integrator fee applies to every loan origination once set, so you configure it once rather than passing it per call. For an overview of how the fee fits into loan proceeds, see How borrow fees work.

If you use this feature, Arc keeps 10% of the custom fee you collect from your end users.

Prerequisites

Before you begin, ensure that you’ve:

These are required so any example below runs with a valid kit and adapter.

Set your fee rate and recipient

Call kit.borrow.setIntegratorConfig with your fee in basis points and the address that receives the fee. This call requires an API key from the Circle Console, passed as apiKey on the operation config. Keep the API key server-side. It produces no wallet signature.

TypeScript

const config = await kit.borrow.setIntegratorConfig({
  integratorFeeBps: 25,
  integratorFeeAddress: "0x1111111111111111111111111111111111111111",
  config: { apiKey: process.env.CIRCLE_API_KEY as string },
});

integratorFeeBps accepts values from 0 to 10000.

Turn the fee off

Pass 0 with a null address to turn off fee collection:

TypeScript

await kit.borrow.setIntegratorConfig({
  integratorFeeBps: 0,
  integratorFeeAddress: null,
  config: { apiKey: process.env.CIRCLE_API_KEY as string },
});

Read your current configuration

Call kit.borrow.getIntegratorConfig to read the stored rate and recipient:

TypeScript

const config = await kit.borrow.getIntegratorConfig({
  config: { apiKey: process.env.CIRCLE_API_KEY as string },
});
console.log(config.integratorFeeBps, config.integratorFeeAddress);

Before the first setIntegratorConfig call, getIntegratorConfig throws CONFIG_NOT_FOUND.

Send

Bridge

Swap

Unified Balance

Onramp

Earn

Borrow

How-to: Configure your integrator fee

Prerequisites

Set your fee rate and recipient

Turn the fee off

Read your current configuration

​Prerequisites

​Set your fee rate and recipient

​Turn the fee off

​Read your current configuration

Prerequisites

Set your fee rate and recipient

Turn the fee off

Read your current configuration