Stellari API — Merchant Reference
Stellari API for merchants — manage payment methods, balances, transactions, payment requests, webhooks, and API keys.
Authentication: All endpoints require either a JWT Bearer token or API Key (HTTP Basic). See the Authentication section for details.
Error format: All errors return {"error": {"code": "...", "message": "...", "type": "..."}}.
Pagination: Cursor-based with limit + cursor query parameters. Responses include has_more and next_cursor.
ID prefixes: ent_ (Entity), pmr_ (PaymentMethod), bal_ (Balance), lde_ (LedgerEntry), txn_ (Transaction), prq_ (PaymentRequest), ak_ (ApiKey), whs_ (WebhookSubscription), wdl_ (WebhookDelivery), iet_ (IntegrationEventType), iev_ (IntegrationEvent).
Sandbox
Authentication (Collapsed)
Login & Session Management
Signup (Collapsed)
User Signup & Verification
Password Management (Collapsed)
Password management related endpoints
Auth Tokens (Collapsed)
OTP resend
Permissions (Collapsed)
Effective role-based permissions for the authenticated caller. The front-end uses this to gate UI; backend handlers enforce the same matrix via #[RequiresPermission] on Commands/Queries.
Entities (Collapsed)
Create and manage entities
- post/v1/entities
- get/v1/entities
- get/v1/entities/{entityId}
- put/v1/entities/{entityId}
- get/v1/entities/{entityId}/children
- post/v1/entities/{entityId}/invitations/resend
- get/v1/entities/{entityId}/invitations
- post/v1/entities/{entityId}/invitations
- get/v1/entities/{entityId}/operators
- post/v1/entities/{entityId}/operators/{userId}/deactivate
- post/v1/entities/{entityId}/operators/{userId}/activate
- get/v1/entities/{entityId}/status
Addresses (Collapsed)
Create and manage entity addresses
Payment Methods (Collapsed)
Fiat wallets, crypto wallets, credit cards, and bank accounts
- get/v1/crypto/supported-assets
- get/v1/payment-methods
- post/v1/payment-methods/bank-accounts
- post/v1/payment-methods/credit-cards
- post/v1/payment-methods/crypto-addresses
- post/v1/payment-methods/crypto-wallets
- post/v1/payment-methods/fiat-wallets
- get/v1/payment-methods/{paymentMethodId}
- delete/v1/payment-methods/{paymentMethodId}
- post/v1/payment-methods/{paymentMethodId}/set-default
- get/v1/payment-methods/{paymentMethodId}/status
Balances (Collapsed)
View your balances and ledger history
Transactions (Collapsed)
Transaction orchestration
- get/v1/transactions
- post/v1/transactions/cashouts
- post/v1/transactions/cashouts/{transactionId}/confirm
- post/v1/transactions/collects
- post/v1/transactions/funds
- post/v1/transactions/purchases
- post/v1/transactions/swaps
- post/v1/transactions/swaps/{transactionId}/confirm
- post/v1/transactions/topups
- post/v1/transactions/transfers
- post/v1/transactions/transfers/{transactionId}/confirm
- get/v1/transactions/{transactionId}
- post/v1/transactions/{transactionId}/fee-quotes
- post/v1/transactions/{transactionId}/refund
- get/v1/refund-intents
- get/v1/transactions/{transactionId}/payment-methods
- post/v1/transactions/{transactionId}/payments
Payment Requests (Collapsed)
Create and pay payment requests (QR-code flow)
Recipients (Collapsed)
Search recipients by email or alias for wallet-to-wallet transfers
TaskEvents (Collapsed)
Mercure SSE stream for async task events
ServerStatus (Collapsed)
Server health check
Webhook Subscriptions (Collapsed)
Create, manage, and test webhook subscriptions for receiving event notifications
- post/v1/webhooks/subscriptions
- get/v1/webhooks/subscriptions
- get/v1/webhooks/subscriptions/{id}
- put/v1/webhooks/subscriptions/{id}
- delete/v1/webhooks/subscriptions/{id}
- post/v1/webhooks/subscriptions/{id}/pause
- post/v1/webhooks/subscriptions/{id}/reactivate
- post/v1/webhooks/subscriptions/{id}/rotate-secret
- post/v1/webhooks/subscriptions/{id}/test
API Keys (Collapsed)
Create and manage API key pairs for programmatic access to any Stellari endpoint
Webhook Deliveries (Collapsed)
View delivery history, inspect attempts, and redeliver events
Webhook Catalog (Collapsed)
Browse available webhook event types
Currencies (Collapsed)
Currency catalog
Notifications (Collapsed)
Backoffice notification inbox — list, mark as read, and bell badge count. Powered by a catalog-driven projector that listens to IntegrationEventPublished and writes per-merchant or platform-wide entries.
Notification Subscriptions (Collapsed)
Per-merchant preferences over which notification types are delivered. Defaults live in the catalog (8 ENTITY-scope event types, 4 default-on, 4 default-off). Merchant overrides are stored only when the merchant explicitly toggles a type.
Recurring Transfers (Collapsed)
Merchant-owned recurring fiat transfers (STELL-139). Wallet → recipient entity, cron-scheduled, with optional expiration / max executions. Each recurring is independently pausable / cancellable; cancellation is terminal but preserves dispatch history.
- get/v1/recurring-transfers
- post/v1/recurring-transfers
- post/v1/recurring-transfers/request-otp
- get/v1/recurring-transfers/{id}
- patch/v1/recurring-transfers/{id}
- delete/v1/recurring-transfers/{id}
- get/v1/recurring-transfers/{id}/executions
- post/v1/recurring-transfers/{id}/pause
- post/v1/recurring-transfers/{id}/resume
Scheduled Transfers (Collapsed)
One-shot future-dated fiat transfers (STELL-144). Wallet → recipient entity, fires exactly once on scheduled_for then transitions to a terminal state. Available to both merchants AND individuals.
Contracts (Collapsed)
Provider contracts attached to an entity: which transaction types, rails, currencies and countries it covers, with its fees and settlement model. Listing requires canViewContracts and creating requires canCreateContract; neither is granted to merchants by default.
Health (Collapsed)
Unauthenticated liveness (/health) and readiness (/health/deep) probes for monitoring. No authentication required.