# Mysoleas API ## V4 ### Api Docs #### Demarrer - [Mysoleas API](https://documentation.mysoleas.com/index.md): Integrez l'ecosysteme Mysoleas avec une gateway unifiee, Identity Cloud et des services metier specialises. - [Demarrage rapide](https://documentation.mysoleas.com/quickstart.md): Le chemin le plus court pour creer une application dans SoleasPay, obtenir un token gateway et lancer une premiere transaction. - [Architecture](https://documentation.mysoleas.com/api-docs/architecture.md): Comprendre la separation entre infrastructure Mysoleas et services metier. - [Ecosysteme Mysoleas](https://documentation.mysoleas.com/api-docs/ecosysteme.md): Distinguer l'infrastructure commune Mysoleas des domaines metier integres dans la plateforme. - [Identity Cloud et OAuth2](https://documentation.mysoleas.com/api-docs/authentication.md): Integrer Mysoleas Identity Cloud pour authentifier vos utilisateurs et gerer vos applications OAuth2. #### Paiements - [Montants et devises](https://documentation.mysoleas.com/api-docs/monetary-units.md): Envoyer et lire les montants en v4, avec les valeurs réelles par défaut et l'option amount_unit. - [Plugins SoleasPay v4](https://documentation.mysoleas.com/api-docs/plugin.md): Integrez SoleasPay rapidement avec Checkout v4 ou Button v4, uniquement avec votre API key. - [Liens de paiement](https://documentation.mysoleas.com/api-docs/payment-links.md): Creer une URL de paiement partageable et suivre le paiement associe. - [Souscriptions](https://documentation.mysoleas.com/api-docs/subscriptions.md): Creer, lister et piloter des paiements recurrents. - [Collections](https://documentation.mysoleas.com/api-docs/collections.md): Encaisser un paiement client avec le flux intent, execute et status. - [Disbursements](https://documentation.mysoleas.com/api-docs/disbursements.md): Envoyer des fonds depuis votre compte Mysoleas vers un wallet client. - [Statuts de transaction](https://documentation.mysoleas.com/api-docs/transaction-statuses.md): Savoir quel endpoint appeler et comment interpreter les etats de chaque transaction. #### Catalogue - [Services, pays et frais](https://documentation.mysoleas.com/api-docs/services-countries-providers.md): Identifier les pays disponibles, choisir un service et verifier son statut. - [Webhooks](https://documentation.mysoleas.com/api-docs/webhooks.md): Recevoir les changements de statut sans dependre uniquement du polling. - [Bonnes pratiques](https://documentation.mysoleas.com/api-docs/best-practices.md): Rendre votre integration Mysoleas fiable, lisible et facile a maintenir. ### Api reference #### Introduction - [Introduction](https://documentation.mysoleas.com/api-reference/introduction.md): Reference technique de la gateway Mysoleas, de Identity Cloud et des domaines metier. #### Mysoleas Identity Cloud - [Configuration Identity Cloud](https://documentation.mysoleas.com/api-reference/oauth/discovery.md): Lire les metadonnees OAuth2/OIDC de Mysoleas Identity Cloud. - [Autoriser une connexion](https://documentation.mysoleas.com/api-reference/oauth/authorize.md): Rediriger un utilisateur vers Se connecter avec Mysoleas avec OAuth2 et PKCE. - [Obtenir un JWT utilisateur](https://documentation.mysoleas.com/api-reference/oauth/token.md): Echanger un code OAuth2 contre un JWT utilisateur Mysoleas Identity Cloud. - [Lire le profil utilisateur](https://documentation.mysoleas.com/api-reference/oauth/userinfo.md): Recuperer les claims de l'utilisateur connecte avec Mysoleas. - [Introspecter un token](https://documentation.mysoleas.com/api-reference/oauth/introspect.md): Verifier l'etat, les scopes et les claims d'un JWT Mysoleas. - [Revoquer un token](https://documentation.mysoleas.com/api-reference/oauth/revoke.md): Invalider un token emis par Mysoleas Identity Cloud. #### Plugin - [Checkout v4](https://documentation.mysoleas.com/api-reference/gateway/checkout-v4.md): Reference d'integration de la checkout hebergee SoleasPay avec une API key. - [Button v4](https://documentation.mysoleas.com/api-reference/gateway/button-v4.md): Reference d'integration du bouton JavaScript SoleasPay avec une API key. #### Liens de paiement - [Creer un lien de paiement](https://documentation.mysoleas.com/api-reference/gateway/payment-link-create.md) - [Lister les liens de paiement](https://documentation.mysoleas.com/api-reference/gateway/payment-link-list.md) - [Payer un lien](https://documentation.mysoleas.com/api-reference/gateway/payment-link-pay.md) #### Souscriptions - [Creer une souscription](https://documentation.mysoleas.com/api-reference/gateway/subscription-create.md) - [Lister les souscriptions](https://documentation.mysoleas.com/api-reference/gateway/subscription-list.md) - [Detail d'une souscription](https://documentation.mysoleas.com/api-reference/gateway/subscription-detail.md) - [Suspendre une souscription](https://documentation.mysoleas.com/api-reference/gateway/subscription-suspend.md) - [Reactiver une souscription](https://documentation.mysoleas.com/api-reference/gateway/subscription-reactivate.md) - [Annuler une souscription](https://documentation.mysoleas.com/api-reference/gateway/subscription-cancel.md) - [Paiements d'une souscription](https://documentation.mysoleas.com/api-reference/gateway/subscription-payments.md) - [Detail d'un paiement de souscription](https://documentation.mysoleas.com/api-reference/gateway/subscription-payment-detail.md) - [Abonnes](https://documentation.mysoleas.com/api-reference/gateway/subscribers.md) #### Collections - [Collection intent](https://documentation.mysoleas.com/api-reference/gateway/collection-intent.md) - [Collection execute](https://documentation.mysoleas.com/api-reference/gateway/collection-execute.md) - [Collection status](https://documentation.mysoleas.com/api-reference/gateway/collection-status.md) - [Devis des frais de transaction](https://documentation.mysoleas.com/api-reference/gateway/transaction-fees-quote.md): Calculer le montant des frais, le montant payable et le porteur des frais avant une transaction. #### Disbursements - [Disbursement intent](https://documentation.mysoleas.com/api-reference/gateway/disbursement-intent.md) - [Disbursement execute](https://documentation.mysoleas.com/api-reference/gateway/disbursement-execute.md) - [Disbursement status](https://documentation.mysoleas.com/api-reference/gateway/disbursement-status.md) #### Catalogue - [Liste des services](https://documentation.mysoleas.com/api-reference/catalog/services-list.md) - [Liste des frais](https://documentation.mysoleas.com/api-reference/catalog/pricing-rule-fees.md): Lister les regles de frais accessibles pour un pays, un service et un tier utilisateur. - [Liste des pays](https://documentation.mysoleas.com/api-reference/catalog/countries-list.md) - [Lire le pays principal](https://documentation.mysoleas.com/api-reference/catalog/primary-country-read.md): Retourner le pays d'exercice principal du tenant courant. - [Definir le pays principal](https://documentation.mysoleas.com/api-reference/catalog/primary-country.md): Marquer une relation TenantCountry comme pays d'exercice principal du tenant. - [Lister les providers](https://documentation.mysoleas.com/api-reference/catalog/providers-list.md) - [Verifier un numero de telephone](https://documentation.mysoleas.com/api-reference/gateway/phone-number-verify.md): Validates a mobile number through the public gateway, detects its country when the international format allows it, and returns the national wallet expected by SoleasPay providers. ## V3 ### Api Docs #### Demarrer - [V3](https://documentation.mysoleas.com/v3/index.md) - [Getting started](https://documentation.mysoleas.com/v3/api-docs/Getting-started.md) - [Mobile Money](https://documentation.mysoleas.com/v3/api-docs/Mobile-Money.md) - [Faas](https://documentation.mysoleas.com/v3/api-docs/Faas.md) - [Using the API](https://documentation.mysoleas.com/v3/api-docs/Using-the-API.md) - [Moving to production](https://documentation.mysoleas.com/v3/api-docs/Moving-to-production.md) #### Paiements - [Collection](https://documentation.mysoleas.com/v3/api-docs/Collection.md) - [Disbursement](https://documentation.mysoleas.com/v3/api-docs/Disbursement.md) - [Refund](https://documentation.mysoleas.com/v3/api-docs/Refund.md) - [SoleasPay Checkout](https://documentation.mysoleas.com/v3/api-docs/SoleasPay-Checkout.md) - [SoleasPay Button](https://documentation.mysoleas.com/v3/api-docs/SoleasPay-Button.md) - [PayLink](https://documentation.mysoleas.com/v3/api-docs/PayLink.md) - [Ebill](https://documentation.mysoleas.com/v3/api-docs/Ebill.md) - [Plugins](https://documentation.mysoleas.com/v3/api-docs/Plugins.md) - [Verify Transaction](https://documentation.mysoleas.com/v3/api-docs/Verify-Transaction.md) #### Services - [E business](https://documentation.mysoleas.com/v3/api-docs/E-business.md) - [Virtual card](https://documentation.mysoleas.com/v3/api-docs/Virtual-card.md) - [So connect](https://documentation.mysoleas.com/v3/api-docs/So-connect.md) #### Dashboard - [Sigin](https://documentation.mysoleas.com/v3/dashboard-doc/sigin.md) - [Search](https://documentation.mysoleas.com/v3/dashboard-doc/search.md) - [Contact](https://documentation.mysoleas.com/v3/dashboard-doc/contact.md) - [Wallet](https://documentation.mysoleas.com/v3/dashboard-doc/wallet.md) - [History](https://documentation.mysoleas.com/v3/dashboard-doc/history.md) ### Api reference #### Authentification - [GetApikey](https://documentation.mysoleas.com/v3/api-reference/endpoint/getApikey.md) - [GetBearer](https://documentation.mysoleas.com/v3/api-reference/endpoint/getBearer.md) #### Paiements - [Collection](https://documentation.mysoleas.com/v3/api-reference/endpoint/collection.md) - [Disbursement](https://documentation.mysoleas.com/v3/api-reference/endpoint/disbursement.md) - [Converter](https://documentation.mysoleas.com/v3/api-reference/endpoint/converter.md) #### Cartes - [UserCard](https://documentation.mysoleas.com/v3/api-reference/endpoint/userCard.md) - [ListUser](https://documentation.mysoleas.com/v3/api-reference/endpoint/listUser.md) - [Create](https://documentation.mysoleas.com/v3/api-reference/endpoint/create.md) - [GetDetails](https://documentation.mysoleas.com/v3/api-reference/endpoint/getDetails.md) - [CardTrans](https://documentation.mysoleas.com/v3/api-reference/endpoint/cardTrans.md) #### SoleasPay Connect - [InitWallet](https://documentation.mysoleas.com/v3/link/endpoint/initWallet.md) - [InitTrans](https://documentation.mysoleas.com/v3/link/endpoint/initTrans.md) - [Fiat](https://documentation.mysoleas.com/v3/link/endpoint/fiat.md) ## OpenAPI Specs - [openapi](/api-reference/openapi.json) - [openapi](/en/v3/api-reference/openapi.json) - [openapi](/v3/api-reference/openapi.json) ## Optional - [Mysoleas](https://mysoleas.com) - [Support](mailto:support@mysoleas.com) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [English (86 pages)](https://documentation.mysoleas.com/_llms/en.txt): Documentation for English. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.