neo-pays

Paiement instantané

Page générée depuis la spécification OpenAPI que la passerelle sert (GET /v1/openapi.json). Ne la modifiez pas à la main : elle est réécrite à chaque build.

Méthode Chemin Description
POST /v1/alias-claims Revendiquer un alias
PUT /v1/alias-claims/{claimId}/response Répondre à une revendication
POST /v1/alias-lookups Résoudre un alias
POST /v1/payouts/{id}/recall Rappeler un versement instantané
GET /v1/pi-aliases Vos alias enrôlés
POST /v1/pi-aliases Enrôler un alias
DELETE /v1/pi-aliases/{cle} Retirer un alias
PUT /v1/pi-aliases/{cle}/claim-response Répondre à une revendication d'alias
POST /v1/qr Émettre un QR EMVCo
POST /v1/rtp Demander un paiement (RTP)
PUT /v1/rtp/received/{end2endId}/response Répondre à une demande reçue
GET /v1/rtp/{id} Consulter une demande de paiement

POST /v1/alias-claims

Revendiquer un alias

Demande le transfert vers vous d'un alias détenu ailleurs.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
Idempotency-Key header non Clé d'idempotence propre à CETTE opération. Rejouer la même clé avec la même charge utile retourne l'originale ; la rejouer avec une charge utile différente est refusé (409).

Réponses

  • 201 — Revendication déposée
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 409 — Clé d'idempotence rejouée avec une charge utile différente
  • 422 — Requête recevable mais refusée : champ manquant, corridor fermé, solde insuffisant
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

PUT /v1/alias-claims/{claimId}/response

Répondre à une revendication

La réponse à une revendication, par son identifiant.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
claimId path oui L'identifiant de la revendication.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

POST /v1/alias-lookups

Résoudre un alias

Interroge l'annuaire : à qui appartient cet alias ?

⚠️ Le nom retourné est celui que l'annuaire détient. Il est comparé à ce que vous affirmez lors d'un envoi : un écart fait refuser l'opération par le schéma.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

POST /v1/payouts/{id}/recall

Rappeler un versement instantané

Demande le rappel d'un versement déjà parti. Le schéma transmet la demande au bénéficiaire ; un rappel n'est jamais un droit de reprise.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
id path oui Identifiant interne, référence de l'opération, ou votre propre client_ref.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

GET /v1/pi-aliases

Vos alias enrôlés

Les alias de paiement enrôlés pour vos comptes auprès de l'annuaire du schéma.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

POST /v1/pi-aliases

Enrôler un alias

Enrôle un alias auprès de l'annuaire.

⚠️ UN alias par compte : un enrôlement supplémentaire est refusé, et un alias orphelin bloque le compte.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
Idempotency-Key header non Clé d'idempotence propre à CETTE opération. Rejouer la même clé avec la même charge utile retourne l'originale ; la rejouer avec une charge utile différente est refusé (409).

Réponses

  • 201 — Alias enrôlé
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 409 — Clé d'idempotence rejouée avec une charge utile différente
  • 422 — Requête recevable mais refusée : champ manquant, corridor fermé, solde insuffisant
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

DELETE /v1/pi-aliases/{cle}

Retirer un alias

Retire l'alias de l'annuaire. Le compte reste ; c'est l'adressage qui disparaît.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
cle path oui La clé de l'alias.

Réponses

  • 204 — Retiré
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

PUT /v1/pi-aliases/{cle}/claim-response

Répondre à une revendication d'alias

Quelqu'un revendique un alias que vous détenez : cette réponse accepte ou refuse le transfert.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
cle path oui La clé de l'alias revendiqué.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

POST /v1/qr

Émettre un QR EMVCo

Un QR statique ou dynamique au format EMVCo : le payeur le scanne avec son application et paie.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
Idempotency-Key header non Clé d'idempotence propre à CETTE opération. Rejouer la même clé avec la même charge utile retourne l'originale ; la rejouer avec une charge utile différente est refusé (409).

Réponses

  • 201 — QR émis
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 409 — Clé d'idempotence rejouée avec une charge utile différente
  • 422 — Requête recevable mais refusée : champ manquant, corridor fermé, solde insuffisant
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

POST /v1/rtp

Demander un paiement (RTP)

Une demande de paiement adressée à un payeur : il la voit et la confirme chez lui. Rien n'est débité sans son accord.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
Idempotency-Key header non Clé d'idempotence propre à CETTE opération. Rejouer la même clé avec la même charge utile retourne l'originale ; la rejouer avec une charge utile différente est refusé (409).

Réponses

  • 201 — Demande émise
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 409 — Clé d'idempotence rejouée avec une charge utile différente
  • 422 — Requête recevable mais refusée : champ manquant, corridor fermé, solde insuffisant
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

PUT /v1/rtp/received/{end2endId}/response

Répondre à une demande reçue

Accepter ou refuser une demande de paiement qui vous est adressée.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
end2endId path oui L'identifiant de bout en bout de la demande.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

GET /v1/rtp/{id}

Consulter une demande de paiement

L'état de la demande et, une fois acceptée, l'opération qui la règle.

ⓘ Famille réservée aux comptes dont le produit « paiement instantané » est activé ; les autres reçoivent 403. Le paiement instantané est le système de la BCEAO, sur lequel Mikaty SN SA est participant.

Paramètres

Nom Emplacement Requis Description
id path oui Identifiant interne, référence de l'opération, ou votre propre client_ref.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After