Skip to main content
Version: 1.0

PagusPay API

PagusPay public API v1 — programmatic access to balances, recipients (Pix) and payout batches, authenticated with a JWT Bearer token created in Settings → API (session routes /api/tokens/*, outside the scope of this spec).

Authentication​

All endpoints require Authorization: Bearer <token>. The token encodes organizationId, userId and scopes — the organization for every request always comes from the token, never from other state.

Scopes​

  • read:balances — GET /v1/balances
  • read:recipients — GET /v1/recipients
  • write:recipients — POST /v1/recipients
  • read:payouts — GET /v1/payout-batches, GET /v1/payout-batches/{id}
  • write:payouts — POST /v1/payout-batches, POST /v1/payout-batches/{id}/submit

Not in V1 (deliberate security decision)​

Payout approval and execution (approve, reject, execute, request-code) are not exposed by this API. The maker/checker flow with email 2FA is human by design — this API is maker-only (creates and submits batches into pending_approval; approval always happens in the app).

Authentication​

Token created in Settings → API. Encodes organizationId, userId and scopes.

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT

Contact

PagusPay:

License