Payouts

Get Payout Eligibility

Returns whether the creator can currently trigger a manual payout, and whether their banking details need updating before they can. Requires permission api_payouts_read_eligibility.

https://public-api.fansmetric.com

GET/v1/{account_id}/payouts/eligibility

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.isVerifiedReasonboolean
true if the account is blocked from payouts for an identity-verification reason.
data.canReceiveManualPayoutboolean
true if a manual payout can be requested right now.
data.needUpdateBankingboolean
true if banking details must be updated before a payout will succeed.
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.isVerifiedReason	boolean	`true` if the account is blocked from payouts for an identity-verification reason.
data.canReceiveManualPayout	boolean	`true` if a manual payout can be requested right now.
data.needUpdateBanking	boolean	`true` if banking details must be updated before a payout will succeed.
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/eligibility" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"isVerifiedReason":false
"canReceiveManualPayout":true
"needUpdateBanking":false
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Get Payout Balances

Get Chargeback Ratio