Infrastructure and business domains
account.mysoleas.com
The account domain is Mysoleas Identity Cloud. It is a full service, not a simple technical dependency.
Use it to:
- integrate the Sign in with Mysoleas button;
- authenticate a user with OAuth2/OIDC;
- manage the identity and user layer of a third-party application;
- obtain a user JWT to open an application session;
- refresh or revoke a token;
- read user claims with
/oauth/v2/userinfo; - allow a third-party application to act in the context of an authorized user or customer.
api.mysoleas.com, create an application in SoleasPay and use its client_id and client_secret to get an application token.
To create an OAuth2 application, the user must have a Mysoleas account, sign in to the dashboard at https://mysoleas.com, then configure the application, redirect URLs, and scopes.
api.mysoleas.com
The API domain is the public gateway. Your integration should not call internal microservices directly.
All gateway routes expect the token obtained from the application created in SoleasPay in the x-sp-auth-token header.
- list countries;
- list payment services;
- verify active providers;
- create and track collections;
- create and track disbursements;
- create payment links;
- manage subscriptions;
- drive the other business domains progressively exposed by Mysoleas.
Gateway authentication rule
The gateway always expects the same header:Business domains in the ecosystem
SoleasPay
SoleasPay is the Mysoleas payment service processor. It aggregates payment methods and exposes collection, disbursement, subscription, payment link, service, country, and provider flows.Mysoleas Identity Cloud
Identity Cloud manages users, OAuth2 applications, user JWT tokens, and claims. It serves as a standalone identity service for a third-party application. Gateway tokens come from applications created in SoleasPay for API integrations.MyShup
MyShup carries sales management and automation. It participates in commercial journeys, products, single-product or multi-product orders, and merchant operations.Notification Service
Notification Service centralizes transactional communications: confirmations, alerts, system messages, and event-driven notifications. It also carries the V2 marketing API for contacts, audiences, templates, and campaigns, with Listmonk as the internal engine.MyBoost
MyBoost covers marketing through boost campaigns, UGC challenges, promotions, customer activation, and marketing follow-up.Standard payment flow
Collections and disbursements use a three-step model.
This model prevents duplicate debits. It also gives you a clear recovery point after a network timeout.
SoleasPay plugin flow
SoleasPay v4 plugins do not follow the same model as server-to-server gateway calls.
Use these plugins for a fast payment integration when you do not want to manage credentials from an application created in SoleasPay, gateway tokens,
intent, execute, and status directly.
Context data
The gateway transports the context of the application created in SoleasPay and the tenant through token claims. It can also forward some internal or trace headers.Important states
A transaction can move through several non-final states before it completes.
Treat
COMPLETED, FAILED, CANCELLED, and REFUNDED as final states.