Payouts

Get Payout Balances

Returns the account's available and pending payout balances, currency, withdrawal limits, and the configured withdrawal cadence. Requires permission api_payouts_read_balances.

https://public-api.fansmetric.com

GET/v1/{account_id}/payouts/balances

API keyBearer

Authorization

default

AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Path Parameters

account_id*integer
OnlyFans numeric account ID.

Response Fields

data.payoutAvailablenumber
Amount currently available to withdraw.
data.payoutPendingnumber
Amount earned but not yet cleared for withdrawal.
data.currencystring
ISO 4217 currency code (e.g. USD).
data.minPayoutSummnumber
Minimum amount per withdrawal.
data.maxPayoutSummnumber
Maximum amount per withdrawal (typically equals payoutAvailable).
data.withdrawalPeriodOptions[]array
Available payout cadences. Each entry has code and human-readable name.
data.manualPayoutPendingDaysinteger
Days a pending balance is held before clearing under the manual cadence.
data.withdrawalPeriodstring
Currently selected cadence code: manual, weekly, or monthly.
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_meta._credits.usedinteger
Credits consumed by this request (currently always 1).
_meta._rate_limits.limit_minuteinteger
Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteinteger
Remaining requests in the current minute window.
_meta._rate_limits.limit_dayinteger
Maximum requests per day for the organization.
_meta._rate_limits.remaining_dayinteger
Remaining requests in the current day window.

Field	Type	Description
data.payoutAvailable	number	Amount currently available to withdraw.
data.payoutPending	number	Amount earned but not yet cleared for withdrawal.
data.currency	string	ISO 4217 currency code (e.g. `USD`).
data.minPayoutSumm	number	Minimum amount per withdrawal.
data.maxPayoutSumm	number	Maximum amount per withdrawal (typically equals `payoutAvailable`).
data.withdrawalPeriodOptions[]	array	Available payout cadences. Each entry has `code` and human-readable `name`.
data.manualPayoutPendingDays	integer	Days a pending balance is held before clearing under the `manual` cadence.
data.withdrawalPeriod	string	Currently selected cadence code: `manual`, `weekly`, or `monthly`.
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_meta._credits.used	integer	Credits consumed by this request (currently always `1`).
_meta._rate_limits.limit_minute	integer	Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minute	integer	Remaining requests in the current minute window.
_meta._rate_limits.limit_day	integer	Maximum requests per day for the organization.
_meta._rate_limits.remaining_day	integer	Remaining requests in the current day window.

curl --request GET "https://public-api.fansmetric.com/v1/100000001/payouts/balances" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"payoutAvailable":8465.22
"payoutPending":35176.26
"currency":"USD"
"minPayoutSumm":20
"maxPayoutSumm":8465.22
"withdrawalPeriodOptions":[0:{"code":"manual"
"name":"Manual payouts"
}
1:{"code":"weekly"
"name":"Weekly payouts"
}
2:{"code":"monthly"
"name":"Monthly payouts"
}
]
"manualPayoutPendingDays":7
"withdrawalPeriod":"manual"
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Get Top Streak

Get Payout Eligibility