Documentation API - Skiiz.cloud

POST /requestpayment

Crée une demande de paiement à un client. Le client recevra une notification pour effectuer le paiement.

Paramètres de la requête

Paramètre	Type	Description	Exemple
senderFirstName	String	Prénom de l'expéditeur	John
senderLastName	String	Nom de l'expéditeur	Doe
senderPhoneNumber	String	Numéro de téléphone avec indicatif	2290151010580
amount	Number	Montant à demander	200
currency	String	Devise (XOF pour le FCFA)	XOF
webhookUrl	String	URL de callback pour notifications	https://webhook.site/...

Exemple de requête

curl --request POST \
  --url 'https://payment.skiiz.cloud/requestpayment?apiKey=live-...' \
  --header 'Content-Type: application/json' \
  --data '{
  "senderFirstName": "John",
  "senderLastName": "Doe",
  "senderPhoneNumber": "2290151010580",
  "amount": 200,
  "currency": "XOF",
  "webhookUrl": "https://webhook.site/..."
}'

Réponse

{
  "statusCode": 200,
  "message": "Payment created",
  "data": {
    "senderFirstName": "John",
    "senderLastName": "Doe",
    "senderPhoneNumber": "2290151010580",
    "amount": 200,
    "currency": "XOF",
    "webhookUrl": "https://webhook.site/..."
  },
  "id": "sathd"
}

POST /deposit

Effectue un dépôt d'argent vers un numéro mobile. Le destinataire reçoit instantanément les fonds.

Paramètres de la requête

Paramètre	Type	Description	Exemple
recipientPhoneNumber	String	Numéro à créditer	2290151010580
amount	Number	Montant à envoyer	250
currency	String	Devise (XOF pour le FCFA)	XOF
webhookUrl	String	URL pour notifications	https://webhook.site/...

Exemple de requête

curl --request POST \
  --url 'https://payment.skiiz.cloud/deposit?apiKey=live-...' \
  --header 'Content-Type: application/json' \
  --data '{
  "recipientPhoneNumber": "2290151010580",
  "amount": "250",
  "currency": "XOF",
  "webhookUrl": "https://webhook.site/..."
}'

Réponse

{
  "statusCode": 200,
  "message": "Payout created",
  "data": {
    "recipientPhoneNumber": "2290151010580",
    "amount": "250",
    "currency": "XOF",
    "webhookUrl": "https://webhook.site/..."
  },
  "id": "dsd01"
}

GET /status/:transactionId

Vérifie le statut d'une transaction existante. Utile pour suivre l'état des paiements ou dépôts.

Exemple de requête

curl --request GET \
  --url 'https://payment.skiiz.cloud/status/pzc8r?apiKey=live-...'

Réponse

{
  "statusCode": 200,
  "success": true,
  "message": "found",
  "data": {
    "transactionReference": "pzc8r",
    "status": "error",
    "statusCode": "409",
    "message": "Insufficient balance",
    "finalized": true,
    "transactionEndTimestamp": 1753698624719
  }
}

GET /balances

Affiche le solde disponible pour chaque opérateur mobile. Permet de vérifier vos fonds disponibles.

Exemple de requête

curl --request GET \
  --url 'https://payment.skiiz.cloud/balances?apiKey=live-...'

Réponse

{
  "statusCode": 200,
  "success": true,
  "message": "found",
  "data": [
    {
      "countryCode": "BJ",
      "currency": "XOF",
      "userId": "wallet-user-id",
      "amount": 39,
      "operator": "MTN"
    }
  ]
}