Quickstart

Make your first omnispay API call in a few minutes: get sandbox credentials, generate a payment link, and confirm the response before moving to production.

  1. Get your API keys

    From the merchant dashboard's Developer page, generate a key pair. You'll get an apiKey, an accountId, and a secretKey. Sandbox keys are prefixed op_test_; production keys are prefixed op_live_. Keep the secret key server-side. It never appears in a URL or client-side code.

  2. Sign your first request

    Every request needs three headers: apiKey, accountId, and X-HMAC-Signature (an HMAC-SHA256 of the request body, signed with your secret key). See Authentication for the full signing recipe.

  3. Call the sandbox

    Point requests at <sandbox-url> and try Generate Payment Link with a test amount. Use the values from Test Cards to simulate a successful or declined payment end to end.

  4. Track the result

    Poll Retrieve Payment Link for status, or configure a webhook to get notified the moment a transaction settles.

  5. Go live

    Swap your sandbox keys for production (op_live_) keys in the dashboard. The request shapes are identical, only the base URL and keys change.

What you can build

Payment links

Generate, retrieve, list, and delete shareable payment links programmatically.

Transaction tracking

Look up a single transaction or pull a full history within a date range.

Payout reporting

Reconcile settlements with per-order or date-ranged payout summaries.

Business details

Fetch your onboarded business profile directly by API key.

Sandbox is free and isolated. Nothing you do against <sandbox-url> moves real money or touches live customer data. Test as much as you need before switching to production keys.

Next steps