Documentation preview

Zuripay API overview

Foundational concepts and gateway to full reference docs.

Authentication

Use dashboard-generated API keys scoped per environment. Include the header X-Zuripay-Key with every request. Rotate keys automatically via the console or CLI.

Endpoints & versioning

Base URL: https://api.zuripay.com/v1/. Pin versions using the ZP-Version header so upgrades are deliberate. Deprecations come with 180-day timelines.

Error handling

Consistent JSON errors with machine-readable codes, human messages, and remediation steps. Use idempotency keys to gracefully retry safe operations.

Rate limits

Standard plans include 600 requests/minute with burst protection. Headers expose remaining credits and reset windows. Enterprise plans negotiate custom tiers.

Wallet creation flow

Provide owner identity, currency, and optional ledger tags. Responses include compliance status and available actions (approve, reject, pending docs).

Webhook events

Each event arrives with a signature header and timestamp. Verify payloads using your webhook secret and replay if necessary from the console.

Version migrations

Use diff docs to understand resource changes. Our migration assistant tests critical flows across staged versions before promoting to production.

Open Developer Console

Access the full API explorer, SDK downloads, and webhook tester.

Open console