Skip to main content
GET
Check Paystack Balance
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Proxied live from Paystack using the workspace’s stored secret key. Balances are returned in the lowest currency unit (kobo for NGN, cents for USD) — divide by 100 to display. Endpoint: /integrations/paystack/balance Authorization:
  • Required role: admin or higher
Method: GET Error codes: the response carries a code when the workspace is not set up — PAYSTACK_INTEGRATION_NOT_CONFIGURED (no enabled Paystack integration) or PAYSTACK_SECRET_KEY_MISSING (row exists, no key). There is no fallback to a platform-level Royalti key by design.

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Response

Live Paystack balance for this workspace

status
boolean
Example:

true

message
string
Example:

"Balances retrieved"

data
object[]