canonical: https://jentic.com/apis/copperx.dev/copperx

# Copperx API

Jentic publishes the only available OpenAPI specification for Copperx API, keeping it validated and agent-ready. Copperx is a stablecoin and crypto payments platform exposing 92 REST endpoints across organizations, users, checkout sessions, payment links, invoices, subscriptions, products, customers and withdrawal addresses. The API supports brand customisation, role-based user management and creation of crypto payment flows that work across multiple chains. Authentication is bearer-token based, and operations are grouped by resource path under `/api/v1`, with dedicated endpoints for organization branding, withdrawal address management and points tokens.

## For AI agents

Create crypto checkout sessions, payment links, invoices and subscriptions on Copperx, plus manage customers, products and organisation branding.

## Scope

Does not handle on-chain custody, exchange trading, or fiat card processing - use for hosted stablecoin checkout, invoicing and subscriptions only.

## Capabilities

- Create a checkout session for a stablecoin payment from a customer wallet
- Generate a reusable payment link tied to a product or amount
- Issue an invoice to a customer with crypto payment instructions
- Set up a recurring subscription against a product price
- Manage withdrawal addresses for an organisation's crypto payouts
- Update an organisation's brand logo and styling on hosted Copperx pages

## Use cases

### Stablecoin Checkout for Online Stores

Online stores accepting stablecoin payments can create a checkout session per cart, redirect the buyer to Copperx's hosted page, and receive a webhook when payment completes. Checkout sessions encode the amount, currency and product references, and return a session URL that the storefront serves to the customer.

Example prompt: Create a Copperx checkout session for 100 USDC tied to product ID 'prod_abc' and return the hosted session URL to redirect the customer.

### Recurring Crypto Subscriptions

SaaS businesses with crypto-native users can charge monthly USDC subscriptions through Copperx by linking a customer to a product price and starting a subscription. The subscriptions and invoices endpoints work together: each billing cycle generates an invoice that the customer settles from their wallet.

Example prompt: Create a customer record from an email, attach product ID 'prod_pro_monthly', and start a monthly subscription billing in USDC.

### Crypto Invoicing for B2B Services

B2B service providers invoicing in crypto can issue Copperx invoices with line items, due dates and customer references, then track payment status through the API. The invoice resource stores the amount, currency and the wallet address the customer used to settle, supporting reconciliation against on-chain transactions.

Example prompt: Create an invoice for customer 'cust_123' with line item description 'Consulting June 2026', amount 5000 USDC, due in 14 days.

### AI Agent Crypto Payment Flow

An AI agent acting on behalf of a finance team can create payment links and invoices on demand by calling Copperx through Jentic. The agent never holds the bearer token and uses Jentic's intent search to pick between checkout sessions, payment links and invoices based on the use case described in natural language.

Example prompt: Use Jentic to create a Copperx payment link for 250 USDC and return the URL to share with the buyer.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/auth/me` | Get the authenticated user |
| GET | `/api/v1/organization` | Get organisation info |
| PUT | `/api/v1/organization/brand` | Update organisation branding |
| GET | `/api/v1/users` | List users in the organisation |
| GET | `/api/v1/organization/withdrawal-addresses` | List withdrawal addresses |
| POST | `/api/v1/organization/withdrawal-addresses` | Create a withdrawal address |
| PUT | `/api/v1/users/{id}/role` | Update a user's role |

## Key resources

- **Auth** — Authenticated user lookup and points-token issuance
- **Organization** — Branding, withdrawal addresses and organisation-level settings
- **Users** — User listing, deletion and role assignment within an organisation
- **Customers** — Customer records that can be billed via invoices and subscriptions
- **Products** — Product catalogue with prices used by checkout sessions and subscriptions
- **Checkout Sessions** — One-off hosted payment sessions for stablecoin checkouts
- **Payment Links** — Reusable hosted payment URLs
- **Invoices** — Crypto invoices issued to customers
- **Subscriptions** — Recurring billing tied to product prices
- **Withdrawal Addresses** — Organisation crypto payout destinations

## Why Jentic

- **Setup:** Wiring Copperx by hand means holding its bearer token and coding the organization, checkout, and invoicing calls yourself across its many endpoints. Through Jentic you install once, import the Copperx API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Copperx works at the organization and user level with targets carried in the request, so scope this by operations: allow the agent the calls it needs, such as reading the organization and creating payment links, and leave changes like updating a user's role or brand out unless you add them. Each operation you credit the agent with stays inside that allowed set.
- **Credential handling:** Your Copperx token is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a Copperx payment link' or 'issue a stablecoin invoice', and Jentic returns the matching operation with its request body schema for amounts, currencies, and product references so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe API** — Fiat-first payment processor with optional crypto support, far broader market coverage
- **PayPal Invoicing API** — Established fiat invoicing platform without native stablecoin settlement
- **Binance API** — Spot exchange for moving received stablecoins into other crypto assets

## FAQ

### Why is there no official OpenAPI spec for Copperx API?

Copperx does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Copperx API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Copperx API use?

Copperx uses bearer token authentication. Through Jentic the bearer token is held in the credential vault and attached to the Authorization header on every Copperx call, so the secret never enters agent context.

### Can I create a recurring crypto subscription with the Copperx API?

Yes. Create a product with a recurring price, attach a customer, and POST against the subscription endpoints. Each cycle generates a new invoice that the customer settles from their wallet, with statuses surfaced through the invoice resource.

### How do I manage withdrawal addresses on the Copperx API?

GET `/api/v1/organization/withdrawal-addresses` lists configured addresses, POST creates a new one, and DELETE `/api/v1/organization/brand-logo` and similar endpoints handle related organisation assets. Treat address creation as security-sensitive and gate it behind admin-only roles.

### What rate limits apply to the Copperx API?

The OpenAPI spec does not declare formal rate limits. Implement exponential backoff on HTTP 429 responses and avoid polling status endpoints when webhooks are available for the same event.

### How do I create a Copperx checkout session through Jentic?

Run pip install jentic, search Jentic with 'create Copperx checkout session', load the operation schema and execute it with the amount, currency and product reference to receive a hosted session URL.

### Can I limit what my agent is allowed to do with the Copperx API?

Yes. Because you run Jentic One yourself, you decide which Copperx operations the agent may call and which stored credential it uses, so you can grant only what a task needs, such as reading the organization and creating payment links or checkout sessions. Sensitive operations like updating a user's role or changing organisation branding stay out of the allowed set unless you explicitly add them. Each operation you credit to the agent stays inside that scope, and the bearer token is injected at execution time rather than exposed to the agent.