Demarrage rapide

Ce guide vous accompagne de l’identite jusqu’au suivi d’une premiere transaction SoleasPay.

1. Preparez vos domaines

Toutes les requetes metier protegees partent vers la gateway.

https://api.mysoleas.com

Toutes les requetes OAuth2/OIDC partent vers Mysoleas Identity Cloud.

https://account.mysoleas.com

Stockez ces URLs dans des variables d’environnement. Cela rend vos tests, vos workers et votre backoffice plus faciles a maintenir.

2. Obtenez un JWT

Si vous integrez le bouton Se connecter avec Mysoleas, utilisez authorization_code avec PKCE. Si votre backend agit en son propre nom, utilisez client_credentials.

curl -X POST "https://account.mysoleas.com/oauth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "sp_client_id": "YOUR_APPLICATION_CLIENT_ID",
    "sp_client_secret": "YOUR_APPLICATION_CLIENT_SECRET"
  }'

La reponse contient un access_token. Ce token est le JWT a transmettre a la gateway.

{
  "access_token": "eyJ...",
  "token_type": "Bearer",
  "token_expired_at": 1785259148
}

3. Appelez la gateway

Transmettez le jeton dans x-sp-auth-token.

curl "https://api.mysoleas.com/service/list?country=CMR&currency=XAF" \
  -H "x-sp-auth-token: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

Vous pouvez aussi transmettre des headers de contexte lorsque votre application gere plusieurs environnements ou pays.

Header	Usage
`x-sp-auth-token`	Jeton Bearer JWT obligatoire pour les routes gateway
`X-Request-Id`	Identifiant de trace cote marchand
`X-Idempotency-Key`	Cle d’idempotence explicite pour les operations sensibles
`X-SP-Country`	Pays actif, par exemple `CMR`
`X-SP-Environment`	Environnement logique, par exemple `prod` ou `dev`

4. Choisissez un service

Listez les services disponibles avant de creer une transaction. Le champ code du service devient la valeur provider dans les payloads de paiement.

curl "https://api.mysoleas.com/service/list?country=CMR&currency=XAF" \
  -H "x-sp-auth-token: Bearer YOUR_ACCESS_TOKEN"

Un service utilisable pour une collection doit avoir is_active: true et is_can_collect: true. Un service utilisable pour un disbursement doit avoir is_active: true et is_can_disburse: true.

5. Lancez une collection

Le flux standard se fait en trois appels: intent, execute, puis status.

curl -X POST "https://api.mysoleas.com/collection/intent" \
  -H "x-sp-auth-token: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 2500,
    "currency": "XAF",
    "transaction_uuid": "2f8b9a68-1ad3-4a0c-a187-40b91a4c44a1",
    "provider": "mtn_cmr",
    "channel": "PROVIDER",
    "customer_wallet": "670000000",
    "description": "Commande MS-10045"
  }'

Dans la requete, customer_wallet ne doit pas contenir l’indicatif du pays.

La reponse contient transaction_reference. Utilisez cette valeur pour executer et suivre la transaction.

curl -X POST "https://api.mysoleas.com/collection/execute" \
  -H "x-sp-auth-token: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transaction_reference": "TRX-20260728-000001",
    "invoice_reference": "MS-10045"
  }'

6. Suivez le statut

Interrogez le statut jusqu’a obtenir un etat final.

curl -X POST "https://api.mysoleas.com/collection/status" \
  -H "x-sp-auth-token: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transaction_reference": "TRX-20260728-000001"
  }'

Les etats finaux sont COMPLETED, SUCCESS, FAILED, CANCELLED et REFUNDED.

Demarrer

Paiements

Catalogue

1. Preparez vos domaines

2. Obtenez un JWT

3. Appelez la gateway

4. Choisissez un service

5. Lancez une collection

6. Suivez le statut

​1. Preparez vos domaines

​2. Obtenez un JWT

​3. Appelez la gateway

​4. Choisissez un service

​5. Lancez une collection

​6. Suivez le statut

1. Preparez vos domaines

2. Obtenez un JWT

3. Appelez la gateway

4. Choisissez un service

5. Lancez une collection

6. Suivez le statut