Atlas Pay

Developer guide · API v1

Download .mdView raw

Your website. One payment flow.

Create a hosted or embedded checkout from your server and confirm the result with a verified payment update.

This integration release is a developer preview. Select Test mode to simulate payments, or switch to Live mode and complete separate Stripe business onboarding to accept real payments. A test checkout cannot collect real money.

Choose your integration

Custom website →

Use the HTTP API from any backend. No Atlas Pay SDK is required.

Payment Element →

Embed secure payment fields, currency choices and a visible FX quote on your website.

WordPress & WooCommerce →

Install the gateway ZIP for hosted checkout and refunds, or use a payment-link shortcode.

Wix →

Install a site-specific Velo payment-provider service plugin. Requires backend code setup.

Make your first request

  1. Sign in and select Test mode. You can create test links and checkouts immediately; Stripe onboarding is only required to accept live payments.
  2. Open Developers. Create a server-side API key for your website’s exact HTTPS origin. For store integrations, enable all six permissions and register the webhook URL provided in the installation guide.
  3. Save the API key and webhook signing secret in your platform’s secret manager. Neither can be shown again.
  4. Check your account and available currencies before creating a checkout.
curl https://dashboard.atlaspay.sh/api/v1/account \
  -H "Authorization: Bearer $ATLAS_PAY_API_KEY"

The first test payment request prepares a separate sandbox automatically. It uses a simulated US account, without changing your residence or business country. Test links, subscription links, and QR checkout do not move real money. Switch to Live mode and complete Stripe verification before accepting real payments.

The API uses bearer keys, not dashboard cookies. Never embed a secret key in a browser, mobile bundle, public repository, or analytics event.

Payments across borders

Read Currencies & FX rates for merchant pricing, buyer currency choices, visible conversion rates and payout differences.

You can offer checkout to international customers where Stripe supports the transaction. That is different from supporting a business in every country. Merchant onboarding, settlement currencies, sanctions restrictions, and local payment methods depend on Stripe’s coverage and the connected account.

GET /capabilities returns supported charge currencies for your merchant country, including decimal precision and required amount multiples. Stripe makes the final eligibility decision for each checkout. Local payment methods are selected dynamically; not every method is available for every currency or buyer.

See Stripe’s merchant availability and currency rules. Atlas Pay does not bypass unsupported-country restrictions.

What this version supports

One-time hosted checkout, current payment status, full and partial refunds, scoped expiring keys, signed callbacks, and a cursor-based event feed. Your server supplies the final order amount, including applicable tax, shipping, and discounts.

Catalog orders can optionally use the shared Atlas buyer wallet, with buyer sign-in, saved-card selection and Stripe-hosted payment confirmation. It needs migration 0009 and separate Stripe configuration. Merchant keys never grant direct access to a buyer's saved cards.

The subscriptions preview adds signed-in enrollment, configurable trials, buyer self-service billing, private bot summaries and a Resend reminder outbox. It requires migration 0010, portal configuration and real-processor acceptance before deployment. Native push notifications are not included.

The delivery preview adds authorization at order placement and capture after a trusted service confirms delivery. New catalog orders require migration 0011 and a separate card-only Stripe configuration. Existing orders, standalone gateway checkouts and subscriptions keep their original payment behavior.

This merchant API does not yet provide recurring enrollment, automatic tax calculation, or multi-party marketplace settlements. Buyer subscription routes are a separate interface and are not automatically exposed through API v1.