Introduction

The Mysoleas API reference is organized around the shared infrastructure and the business domains.

Layer	Server	URL	Role
Infrastructure	Gateway	`https://api.mysoleas.com`	Routes calls to business services
Infrastructure	Mysoleas Identity Cloud	`https://account.mysoleas.com`	OAuth2/OIDC, Sign in with Mysoleas, user management, user JWT, and userinfo
Business	SoleasPay	via `api.mysoleas.com`	Payments, links, subscriptions, collections, disbursements, countries, services, and providers

Mysoleas Identity Cloud can be integrated on its own to manage authentication and users for a third-party application. In that case, your application uses account.mysoleas.com, validates the user JWT, reads userinfo, then continues with its own APIs. To create an OAuth2 application, sign in to the Mysoleas dashboard:

https://mysoleas.com

Protected gateway routes use this header:

x-sp-auth-token: Bearer <access_token>

This token is obtained with the client_id and client_secret of the application created in SoleasPay. It is distinct from the user JWT issued by Mysoleas Identity Cloud.

OAuth2 endpoints themselves live on account.mysoleas.com. SoleasPay gateway endpoints use a token obtained from an application created in SoleasPay. SoleasPay v4 plugins use a merchant apikey and do not require this header.

The public payment-link route exposed in this reference is:

POST https://api.mysoleas.com/pay/{shortCode}/pay to submit the payment.

Success format

{
  "code": 200,
  "success": true,
  "data": {},
  "locale": "en",
  "message": "transaction_submitted"
}

Error format

{
  "success": false,
  "code": 400,
  "message": "empty_data"
}

Pagination

Lists generally accept page and limit. The response can contain meta.pagination.

{
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 120,
    "pages": 5,
    "has_next": true,
    "has_previous": false
  }
}

Amounts in v4

Send amount in major units by default: 4.01 for 4.01 USD/EUR. API clients that already send cents can set amount_unit: "MINOR" at the root of the JSON body, alongside amount and currency, rather than in metadata. Public responses return major units even when the request uses MINOR. See amounts and currencies.

Mysoleas Identity Cloud

Plugin

Payment links

Subscriptions

Collections

Disbursements

Catalog

Introduction

Success format

Error format

Amounts in v4

​Success format

​Error format

​Pagination

​Amounts in v4

Success format

Error format

Pagination

Amounts in v4