Skip to main content

Overview

Every payment in Shoppex starts with an invoice. Whether a customer checks out through your storefront, clicks a payment link, or your backend creates one via API — the invoice is always the central object that tracks who is paying, what they’re buying, and whether the payment succeeded.
This guide covers the Shoppex invoice model used by both hosted checkout flows and the Developer API.
An invoice can go through more than one payment attempt before it reaches its final state. A customer might try PayPal, abandon it, and come back with a credit card — it’s still the same invoice.

Invoice Statuses

Creating an Invoice

Via Dashboard

1

Navigate to Invoices

Go to Invoices → Create Invoice
2

Select products

Select products and quantities
3

Enter customer email

Enter customer email (optional)
4

Choose payment methods

Choose allowed payment methods
5

Create the invoice

Click Create

Via API (Developer API)

Use the POST /payments endpoint to create an invoice programmatically:

Completing or Processing an Invoice

The Dashboard calls the manual merchant action Process Invoice. The public Developer API calls the same operation complete invoice:
Use it only after your server has independently confirmed payment. The invoice must still be PENDING or PENDING_PAYMENT; an already completed or otherwise non-completable invoice returns 422 VALIDATION_ERROR. Every request must include an Idempotency-Key header. See Manual payment auto-completion for request examples, idempotency, webhook verification, and common errors.

Invoice Expiration

By default, Shoppex-hosted invoice payment windows expire after 24 hours. You can customize the default expiration in Settings → Invoices.
The current Dev API payment example on this page does not accept an expires_at request field. Configure a different default expiration in the dashboard instead.
Expired invoices cannot be paid. Create a new invoice for the customer if needed.

Partial Payments

Partial payments can occur with cryptocurrency when the customer sends slightly less than required. You can:
Mark the invoice as paid manually from the dashboard. Use this when the shortfall is negligible and you want to fulfill the order immediately.
Customer pays the difference. The invoice stays in PARTIAL status until the remaining amount is received, then transitions to COMPLETED.
Cancel and refund the partial payment. The invoice moves to VOIDED and you can create a new one if needed.

Webhooks

Get notified when invoice status changes:
See Webhooks Guide for setup instructions.

Integration Rule

If you sync invoices into your own system, use the Shoppex invoice status as the final source of truth. The first payment attempt might fail, the second might succeed — the invoice ends as COMPLETED regardless of how many tries it took.
React to the final invoice state via webhook events, not to individual gateway callbacks. This is the single most important integration rule in Shoppex.

Next Steps

Payments Guide

Learn about payment gateways, configuration, and processing.

Webhooks Guide

Set up real-time notifications for invoice status changes.