FlexApp Docs

Versements (décaissement)

Envoyez de l'argent à un ou plusieurs comptes Switag depuis votre solde de reversement (ce que vous avez encaissé). Ponctuel, en masse, ou programmé — pour payer des fournisseurs, des vendeurs, des salaires, des cashback…

Scope requis

Les versements exigent une clé avec le scope disbursements.write.

Verser à un compte#

POST/v1/biz/payoutsdisbursements.write
ChampTypeDétail
recipientstringRequis. @tag Switag du bénéficiaire.
amountentierRequis. Plus petite unité (XOF sans décimale).
referencestringVotre référence (paie, facture…).
notestringNote libre.
Terminal
curl -X POST https://api-switag.pluxce.com/v1/biz/payouts \
  -H "X-Api-Key: pk_test_…" -H "X-Api-Secret: sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"recipient":"@awa","amount":5000,"reference":"SALAIRE-05"}'

Réponse 201#

JSON
{
  "id": "023bfc33-…",
  "recipient": "@awa",
  "amount": 5000,
  "currency": "XOF",
  "reference": "SALAIRE-05",
  "state": "paid",
  "transaction_id": "ceef2966-…"
}
ChampValeursDétail
statepaid · failedRésultat du versement.
failure_codevoir ErreursPrésent si state=failed (insufficient_balance, recipient_not_found…).
transaction_iduuidTransaction ledger (si paid).

Le bénéficiaire est crédité instantanément et notifié (push « Paiement reçu »).

Verser en masse#

POST/v1/biz/payouts/batchdisbursements.write

Jusqu'à 500 lignes ; chaque ligne réussit ou échoue indépendamment (rapport par bénéficiaire).

Terminal
curl -X POST https://api-switag.pluxce.com/v1/biz/payouts/batch \
  -H "X-Api-Key: pk_test_…" -H "X-Api-Secret: sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"recipient":"@awa","amount":5000},{"recipient":"@koffi","amount":7500}]}'

Programmer (paie, récurrent)#

POST/v1/biz/payout-schedulesdisbursements.write

recurrence = once (une fois), weekly ou monthly. start_at = première exécution ; items = la liste payée à chaque exécution.

Terminal
curl -X POST https://api-switag.pluxce.com/v1/biz/payout-schedules \
  -H "X-Api-Key: pk_test_…" -H "X-Api-Secret: sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"recurrence":"monthly","reference":"PAIE","items":[{"recipient":"@awa","amount":120000}]}'

Annulez avec POST /v1/biz/payout-schedules/{id}/cancel. Tout est aussi disponible sans code depuis le tableau de bord → Versements.

Traitement des schedules

Les schedules sont exécutés par un job serveur périodique. Un schedule ne produit pas de webhook dédié aujourd'hui: utilisez les listes de versements et vos références métier pour le suivi.