Skip to main content
GET
/
v1
/
settlement
/
config
Retrieve settlement config
curl --request GET \
  --url https://api.leanrails.com/v1/settlement/config \
  --header 'Authorization: Basic <encoded-value>'
{
  "object": "settlement_config",
  "fee_model": "<string>",
  "fee_percentage_bps": 123,
  "fee_fixed_cents": 123,
  "settlement_schedule": "<string>",
  "settlement_delay_days": 123,
  "rolling_reserve_bps": 123,
  "rolling_reserve_days": 123,
  "min_payout_amount": 123,
  "auto_payout_enabled": true,
  "currency": "<string>",
  "interchange_markup_bps": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.fluveo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use your secret API key as the username with an empty password.

Headers

X-API-Version
string

Override the API version for this request.

Response

The settlement configuration.

object
enum<string>
required
Available options:
settlement_config
fee_model
string
required

Fee model (e.g. percentage, flat_rate, interchange_plus).

fee_percentage_bps
integer
required

Fee as basis points (e.g. 290 = 2.90%).

fee_fixed_cents
integer
required

Fixed fee per transaction in cents.

settlement_schedule
string
required

Payout schedule (e.g. daily, weekly, monthly).

settlement_delay_days
integer
required

Number of days before funds are available for payout.

rolling_reserve_bps
integer
required

Rolling reserve percentage in basis points.

rolling_reserve_days
integer
required

Number of days funds are held in rolling reserve.

min_payout_amount
integer
required

Minimum payout amount in cents.

auto_payout_enabled
boolean
required

Whether automatic payouts are enabled.

currency
string
required

Three-letter ISO currency code.

interchange_markup_bps
integer | null

Interchange markup in basis points.