Skip to content

Payout & transfer KPIs

GET
/admin/payouts/stats

Aggregate KPIs for the Payout Management page, computed from the same evidence model as the transfers grid so the tiles always agree with the rows. Requires the view_platform_analytics permission.

Authorizations

BearerAuth

Authentication is handled automatically via httpOnly session cookies after signing in at /cognito/signin or via Google SSO at /cognito/oauth/google. For Swagger UI testing, paste a JWT token from the /cognito/signin response.

Type
HTTP (bearer)

Responses

Payout statistics

application/json
JSON
{
"data": {
"totalAccounts": 0,
"pendingOnboarding": 0,
"verifiedAccounts": 0,
"monthlyVolume": 0,
"monthlyPlatformFees": 0,
"heldTransferCount": 0,
"heldTransferAmount": 0,
"heldAwaitingOnboardingCount": 0,
"heldAwaitingOnboardingAmount": 0,
"pendingSettlementCount": 0,
"pendingSettlementAmount": 0,
"anomalyCount": 0,
"anomalyAmount": 0,
"transferredCount": 0,
"totalTransfers": 0
}
}

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI

Built with VitePress