API Reference

The Supapay API is organized around REST. It uses predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

Authentication

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must provide a Secret Key in the Authorization header.

Authorization: Bearer sk_test_...

Core Resources

Wallets

Manage merchant wallets and their configurations.

• POST /wallets: Create a new wallet.
• GET /wallets/:id: Retrieve wallet details and balance projection.

Vaults

Manage segregated fund containers and their rules.

• POST /vaults: Create a new vault.
• POST /vaults/rules: Add a sweep or limit rule to a vault.

Payouts

Initiate external bank transfers.

• POST /payouts: Initiate an external transfer.
• GET /payouts/:ref: Check the status of a payout transaction.

---

For a full list of endpoints and their parameters, see the platform API documentation when it is published for your environment.