Skip to main content

🚀 Getting Started with Zoqq APIs

Welcome to Zoqq — your all-in-one platform for secure authentication, digital payments, virtual account management, card issuance, foreign exchange, payouts, and real-time webhook integrations through seamless, developer-friendly APIs.

This guide is designed to help you integrate Zoqq APIs quickly and confidently, whether you're building a sandbox app or preparing for production.

🔑 Key Points Before You Start​

  • Always collect and secure your API keys. Never expose your secret keys in frontend code.
  • The API secret key is delivered securely to your email by Zoqq.
  • Use a unique x-request-id for each API request to ensure idempotency and reliable tracking.

🧪 Use the Sandbox Environment​

Zoqq provides a fully isolated sandbox for safe testing of your integrations.

  • Sandbox credentials have been shared via email to your team.
  • Always use sandbox-specific API keys when testing.
  • No real financial transactions are processed in the sandbox.
  • Simulate different scenarios to test your app without impacting real users.

🌐 Sandbox Base URL : https://api.sandbox.zoqq.com — Used for development and testing. All transactions in this environment are simulated and safe.

💡 Tip: Treat the sandbox as a playground — experiment with all API endpoints and verify your logic.

🧩 Test APIs Using the Built-in Playground​

Zoqq provides an API Playground (Try It Out) directly within the documentation, allowing you to test APIs without leaving the website.

  • Execute API requests directly from the documentation
  • Test endpoints in real time using sandbox credentials
  • Manually enter the required request headers
  • Complete the provided boilerplate request body template
  • Instantly view API responses and error messages
  • Ideal for quick validation and understanding API behavior

👉 The API Playground uses sandbox credentials only and does not process real transactions.

💡 Tip: Once the required headers are filled and the request body template is completed, you’re good to go—no additional setup required.

📦 Test Faster with Postman​

To help you get started quickly, Zoqq provides a ready-to-use Postman collection.

  • Import the Zoqq Postman collection to explore all available APIs
  • Pre-configured requests help you understand required headers and payloads
  • Easily test authentication, accounts, cards, FX, payouts, and webhooks
  • Use environment variables for base URLs, API keys, and access tokens

👉 This allows you to validate API behavior without writing code upfront.

⚡ Getting Started with Zoqq APIs​

Follow these essential steps to start integrating:

  1. Authentication Section – Obtain access tokens to securely authenticate and authorize API requests.
  2. Onboarding Section – Create users, retrieve user details, and manage KYC verification to enable seamless customer onboarding.
  3. Account Section – Create and manage virtual accounts, including balance checks, transaction history, and account-related operations.
  4. Cardholder Section – Set up a new cardholder in the system.
  5. Card Section – Issue a virtual or physical card to your cardholder.
  6. Foreign Exchange Section – Perform currency conversion, retrieve exchange rates, and manage FX-related transactions.
  7. Beneficiary Section – Create and manage beneficiaries for payouts, including validation and beneficiary details management.
  8. Payout Section – Initiate and track payouts to beneficiaries, supporting multiple payout methods and statuses.
  9. Webhook Section - Manage webhook subscriptions and event notifications.
  10. Explore Full API Reference – Access all endpoints and features for advanced integrations.

📎 Next Steps​

💬 Need Help?​

If you encounter any issues or need guidance:
Contact developer support at: support@zoqq.com

We're here to help you integrate smoothly and efficiently.