Skip to main content

Overview

There are three ways to accept payments with Shoppex:

Storefront

Customers browse your shop and checkout directly

Payment Links

Share a link that takes customers straight to checkout

API

Create invoices programmatically from your app
This guide covers both hosted/public Shoppex flows (storefront, payment links) and Developer API flows (POST /dev/v1/payments, POST /dev/v1/orders).

The Payment Flow

You don’t need to integrate with Stripe or PayPal directly. Shoppex handles all gateway communication for you.

Important Integration Rule

One Shoppex invoice can have more than one payment attempt over time. A customer might open checkout, try PayPal, abandon it, come back and finish with Stripe. This surprises most people integrating for the first time. The important thing: redirect the customer to the Shoppex checkout URL, listen for webhook events, and fulfill based on the final invoice status. Don’t build your fulfillment logic around a single provider-side session ID.

Method 1: Storefront (Hosted/Public)

Your storefront at yourshop.shoppex.io is ready out of the box:
  1. Customer browses products
  2. Adds to cart
  3. Completes checkout
  4. Receives product automatically
Best for: Digital products, subscriptions, simple e-commerce
Create a link that goes directly to checkout - perfect for sharing on social media, emails, or anywhere.

Create via Dashboard

  1. Go to Products → Your Product
  2. Click Copy Payment Link
  3. Share the URL: https://yourshop.shoppex.io/product/your-product

Create via API

If you pass webhook, Shoppex sends payment lifecycle events only for that created payment/invoice to that URL. Store webhook_secret immediately; it is not returned on later reads. The webhook value must be your own HTTP(S) endpoint. Discord webhook URLs are not compatible with Shoppex developer-event payloads; configure Discord notifications under Notifications → Sales Alerts instead. Best for: Social media sales, email campaigns, one-off payments

Method 3: API Integration (Developer API)

Use the Developer API when you need your own checkout UI or backend-driven payment flow.

Payment vs Order

POST /dev/v1/payments and POST /dev/v1/orders look similar, but they solve different problems. Use POST /dev/v1/payments when you have your own checkout and just want a hosted payment URL. You don’t get Shoppex catalog line items or automatic product delivery. Use POST /dev/v1/orders when you want to charge for real Shoppex products — with line items, variants, and automatic delivery (files, serials, subscriptions, or DYNAMIC). The quick rule: payments = generic developer payment. orders = catalog-backed Shoppex order.
Subscriptions, serials, files, and DYNAMIC delivery always require POST /dev/v1/orders.POST /dev/v1/payments creates a one-off developer invoice with a free-form title and amount. It does not link to catalog products, does not create subscription records, and does not appear in the Subscriptions dashboard tab.A common integration mistake: load a product from GET /dev/v1/products, then call POST /dev/v1/payments with that product’s title and price. That disconnects checkout from the catalog. Pass the product uniqid in POST /dev/v1/orders instead.The API returns 422 when POST /dev/v1/payments receives catalog fields such as product_id or items.Recurring-billing custom fields such as plan_type still create the payment, but the 201 response includes a warnings array with code subscription_checkout_mismatch pointing you to POST /dev/v1/orders.

Need to know which payment methods the shop currently accepts?

Use GET /dev/v1/me/capabilities for that. A common mistake: GET /dev/v1/payments returns existing payment records, not the shop’s payment configuration. If you want to know which gateways (Stripe, PayPal, Crypto) are enabled, use GET /dev/v1/me/capabilities instead.
Crypto payments require a connected crypto provider: your own OxaPay, Cryptomus, or NowPayments account (connected in the dashboard under Settings → Payments → Crypto), or a Native Crypto wallet. GET /dev/v1/me/capabilities shows the enabled payment methods and native crypto gateways for your shop.

Skip the crypto picker on hosted checkout

If you want to keep Shoppex hosted checkout but open a concrete coin directly, pass:
  • gateway: the merchant crypto provider you want Shoppex to use
  • crypto_gateway: the concrete coin or network the buyer should pay with
This works for merchant crypto providers like OXAPAY, CRYPTOMUS, and NOWPAYMENTS.
cURL
Example response shape:
Simple example:
  • gateway: "OXAPAY" + crypto_gateway: "TRON" -> hosted checkout opens directly on TRON
  • gateway: "CRYPTOMUS" + crypto_gateway: "USDT_TRC20" -> hosted checkout opens directly on USDT TRC20
  • gateway: "NOWPAYMENTS" + crypto_gateway: "BITCOIN" -> hosted checkout opens directly on Bitcoin via your NowPayments account
  • gateway: "NATIVE_CRYPTO" + crypto_gateway: "LITECOIN" -> Shoppex derives a non-custodial Litecoin receive address from your active native wallet
If you omit crypto_gateway, the buyer lands on the normal generic crypto payment selection first. If you only send crypto_gateway without gateway, Shoppex uses your active native wallet when it covers that coin, otherwise your connected crypto provider — and starts the crypto session immediately. Without any connected crypto provider or native wallet the request fails with a validation error.

Native Crypto Payments (BTC, LTC, USDT-TRC20, SOL, USDT-SPL)

Use this flow when you want crypto paid directly into your own non-custodial wallet. Shoppex assigns a fresh receive address from your active native wallet (derived from your wallet key, or pre-created on your device for Solana), watches the chain, and marks the payment paid after the chain’s confirmation policy. Shoppex does not create a provider payment and does not hold keys or funds. Check availability first:
cURL
Look for:
Create a native Litecoin payment:
cURL
Example response shape:
If gateway is NATIVE_CRYPTO, Shoppex fails if no active native wallet exists for the requested chain. If you only send crypto_gateway (for example "BITCOIN" or "SOLANA"), an active native wallet is prioritized over external providers offering the same coin.

White-label Crypto Checkout (removed)

Shoppex-managed white-label crypto checkout has been removed, together with the white_label request parameter. Crypto payments always use your own accounts now:
  • Native Crypto for non-custodial receive addresses from your own wallet (BTC, LTC, USDT-TRC20, SOL, USDT-SPL)
  • Your own OxaPay, Cryptomus, or NowPayments account for other coins
Historical white-label crypto payments can still be read through the Developer API and can still complete through the normal payment lifecycle. Requests that still send white_label are rejected by schema validation.

Create a Payment

If you create the payment with gateway: 'PANDABASE', Shoppex also returns checkout_url and session_id.
  • use data.checkout_url if you want the direct Pandabase checkout session URL
  • keep listening for Shoppex webhooks for the final paid/cancelled state
Server-side completion is also different:
  • POST /dev/v1/payments/:id/complete confirms a generic developer payment only
  • POST /dev/v1/orders/:id/fulfill completes and fulfills a catalog-backed order
  • POST /dev/v1/orders/:id/complete is the same completion pipeline, exposed as an alias for integrations that look for a complete endpoint

Handle the Webhook

After payment, Shoppex sends a webhook to your server. Use the webhook_secret returned by POST /dev/v1/payments for a per-payment webhook. Use the endpoint secret from Settings -> Webhooks only for global webhook endpoints.
Always verify webhook signatures in production. New integrations should use X-Shoppex-Signature-V2. See the Webhooks Guide for details.

Dynamic Product Fulfillment

If you use products with type: "DYNAMIC", there is one more callback contract to implement: dynamic_webhook. This is separate from normal Shoppex event webhooks and uses the product’s dynamic webhook signing secret, not the secret from Settings -> Webhooks. The order:paid webhook tells your app that the invoice is paid. The dynamic_webhook is a separate fulfillment callback that asks your server for the delivered token, key, or access data. Use the dedicated contract docs here:
Rule of thumb:
  • Use Payment Links for simple, shareable checkouts
  • Use Invoices when you need control over the checkout or customer data

Payment Gateways

Configure your payment providers in Settings → Payments. Supports: Credit cards, Apple Pay, Google Pay, SEPA, Klarna, and more.
1

Get API Keys

Log in to Stripe DashboardDevelopers → API Keys
2

Add to Shoppex

Enter your Publishable Key and Secret Key in Settings → Payments → Stripe
3

Configure Webhook

In Stripe Dashboard, create a webhook pointing to:

PayPal

1

Create REST App

Go to PayPal Developer → Create App
2

Add Credentials

Enter Client ID and Secret in Settings → Payments → PayPal

Cryptocurrency

Two options available:

Testing Payments

Enable Test Mode in Settings before going live.

Test Card Numbers

Use any future expiry date and any 3-digit CVC.
These numbers are Stripe-specific. PayPal and crypto gateways have their own sandbox modes.

Test Checklist

1

Create Test Invoice

Create an invoice via dashboard or API
2

Complete Checkout

Pay with test card 4242 4242 4242 4242
3

Verify Webhook

Check that your webhook endpoint received order:paid
4

Check Fulfillment

Confirm the product was delivered (email, license, download)
Use ngrok to test webhooks locally:

Common Scenarios

  1. Create product with File delivery type
  2. Upload your file
  3. Share your storefront or payment link
  4. Customer pays → receives download automatically
  1. Create product with Serials delivery type
  2. Add license keys (one per line)
  3. Customer pays → receives unique license key
  1. Create payment via API with customer email
  2. Redirect customer to data.url
  3. Listen for order:paid webhook
  4. Fulfill order in your system
  1. Create a Manual gateway with redirect URL and {{invoice_id}} template vars
  2. Listen for order:manual_payment_pending on your shop webhook
  3. When your PSP confirms payment, call POST /dev/v1/invoices/{uniqid}/complete
  4. Shoppex delivers the product and sends order:paid
See Manual payment auto-completion for a Cloudflare Worker example.
  1. Create product with Subscription type
  2. Set billing interval (monthly, yearly, etc.)
  3. Customer pays → subscription created
  4. Renewals happen automatically
See Subscriptions Guide for details.

Next Steps

Invoices

Deep dive into invoice lifecycle and statuses

Webhooks

Set up real-time notifications

Subscriptions

Set up recurring billing

API Reference

Explore all endpoints