- Mysoleas infrastructure, which carries identity, security, routing, and the gateway;
- business domains, which carry business use cases such as payments, sales, notifications, and marketing.
Public entry points
All gateway routes expect a Bearer JWT in the
x-sp-auth-token header.
SoleasPay
Checkout v4 and Button v4 are the deliberate exception: they integrate with a merchant apikey to make payment integrations faster.Start the integration
Get a JWT, call the gateway, and launch your first transaction.
Understand the architecture
See how the gateway, Identity Cloud, and business domains work together.
Explore the ecosystem
Place SoleasPay, MyShup, Notification Service, MyBoost, and Identity Cloud in the right context.
Sign in with Mysoleas
Integrate OAuth2/OIDC and use the JWT to call the gateway when needed.
SoleasPay v4 plugins
Add Checkout v4 or Button v4 with a simple merchant API key.
API reference
Find endpoints, payloads, headers, and schemas for each resource.
Mysoleas business domains
What you can build with SoleasPay
Collect payments
Use collections to request a payment from a customer. Mysoleas returns a reference, drives the provider, and lets you follow the status until a final state.Send payouts
Use disbursements to send funds from your Mysoleas balance to a customer wallet. The flow checks the balance, reserves the funds, executes the payout, and synchronizes the status.Automate billing
Use subscriptions to charge a customer on a defined frequency. Each subscription payment has its own reference and status.Simplify checkout
Use payment links to create a shareable URL. The customer pays on a public page while your backend keeps the reference and follows the lifecycle.Integrate quickly
UseCheckout v4 or Button v4 when you want to add SoleasPay to a third-party application with an apikey, without managing OAuth2 or direct gateway calls.
Gateway response convention
Application APIs return a stable JSON envelope.success is false and message contains the reason your backend can act on.
