Skip to main content
Mysoleas is not a monolithic API. It is an ecosystem of business services exposed through shared infrastructure. This distinction matters for clean integrations:
  • infrastructure gives you entry points, identity, security, and routing;
  • business domains carry business capabilities: payments, sales, communication, marketing, and user management.

​
Mental model

​
Mysoleas infrastructure

Infrastructure is the transversal layer. It does not replace business products. It makes them accessible in a unified way. The gateway receives requests from your applications, verifies the security context, then routes to the right business domain.
All gateway routes expect a Bearer JWT in the x-sp-auth-token header.

​
Business domains

Each business domain has its own vocabulary, objects, and flows.

​
SoleasPay in the gateway

SoleasPay is the payment service processor of the ecosystem. In this documentation, the covered gateway routes mainly concern SoleasPay. Use these route families to:
  • list available countries;
  • list payment services;
  • verify provider status;
  • create and track collections;
  • create and track disbursements;
  • create and manage payment links;
  • create and manage subscriptions.
These routes go through:
They use:

​
Mysoleas Identity Cloud

Mysoleas Identity Cloud is a full service. It lets you integrate the Sign in with Mysoleas button into a third-party website or application. You can use it as a standalone authentication service. In that case, your application authenticates the user through Mysoleas, reads their claims, opens its own session, and continues with its own business logic without calling the gateway. To create an OAuth2 application, sign in to the Mysoleas dashboard:
Configure your application, redirect URLs, and authorized scopes before starting the OAuth2 flow. The recommended flow for a web application is OAuth2 authorization_code with PKCE:
  1. Your application displays Sign in with Mysoleas.
  2. The user is redirected to account.mysoleas.com.
  3. Mysoleas authenticates the user and requests consent if needed.
  4. Your application receives a code.
  5. Your backend exchanges the code for a JWT.
  6. Your application opens a local session or calls the gateway with x-sp-auth-token if it consumes a Mysoleas business service.
For a backend that acts on its own behalf, use client_credentials.

​
SoleasPay v4 plugins

Checkout v4 and Button v4 plugins are deliberately simpler. They let you integrate SoleasPay quickly into a third-party application with a merchant apikey, without OAuth2, without JWT, and without manual gateway calls. If you build a complete payment journey with your own backend calls, use the gateway. If you want a fast payment integration with very little code, use the v4 plugins.