Tontines

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/pi-persons`	Enregistrer une personne
`GET`	`/v1/pi-persons/{ref}`	Consulter une personne
`POST`	`/v1/tontines`	Créer une tontine
`POST`	`/v1/tontines/alias-lookups`	Résoudre l'alias d'un participant
`GET`	`/v1/tontines/{ref}`	Consulter une tontine
`POST`	`/v1/tontines/{ref}/close`	Clore une tontine
`GET`	`/v1/tontines/{ref}/payouts`	Versements du pot
`POST`	`/v1/tontines/{ref}/payouts`	Verser le pot
`GET`	`/v1/tontines/{ref}/rtp`	Cotisations appelées
`POST`	`/v1/tontines/{ref}/rtp`	Appeler les cotisations
`POST`	`/v1/tontines/{ref}/transfer-pool`	Déplacer le pot

`POST /v1/pi-persons`

Enregistrer une personne

Enregistre un participant et son compte de schéma, préalable à toute tontine.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

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 — Personne enregistré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

`GET /v1/pi-persons/{ref}`

Consulter une personne

La personne et ses comptes.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

Paramètres

Nom	Emplacement	Requis	Description
`ref`	path	oui	La référence de la personne.

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/tontines`

Créer une tontine

Ouvre un pot et son calendrier.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

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 — Tontine créé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

`POST /v1/tontines/alias-lookups`

Résoudre l'alias d'un participant

La résolution d'annuaire, restreinte au périmètre tontine.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

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/tontines/{ref}`

Consulter une tontine

Le pot, ses participants et son état.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

Paramètres

Nom	Emplacement	Requis	Description
`ref`	path	oui	La référence de la tontine.

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/tontines/{ref}/close`

Clore une tontine

Ferme le pot. Un pot dont le solde n'est pas nul ne se ferme pas.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

Paramètres

Nom	Emplacement	Requis	Description
`ref`	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/tontines/{ref}/payouts`

Versements du pot

Les versements déjà effectués depuis ce pot.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

Paramètres

Nom	Emplacement	Requis	Description
`ref`	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

`POST /v1/tontines/{ref}/payouts`

Verser le pot

Verse le pot au bénéficiaire du tour.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

Paramètres

Nom	Emplacement	Requis	Description
`ref`	path	oui	Identifiant interne, référence de l'opération, ou votre propre `client_ref`.
`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 — Versement créé
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

`GET /v1/tontines/{ref}/rtp`

Cotisations appelées

Les demandes émises sur ce pot et leur état.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

Paramètres

Nom	Emplacement	Requis	Description
`ref`	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

`POST /v1/tontines/{ref}/rtp`

Appeler les cotisations

Émet une demande de paiement à chaque participant attendu sur ce tour.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

Paramètres

Nom	Emplacement	Requis	Description
`ref`	path	oui	Identifiant interne, référence de l'opération, ou votre propre `client_ref`.
`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 — Demandes émises
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/tontines/{ref}/transfer-pool`

Déplacer le pot

Déplace le solde du pot vers un autre compte de la plateforme.

ⓘ Famille réservée aux comptes dont le produit « tontine » est activé ; les autres reçoivent 403.

Paramètres

Nom	Emplacement	Requis	Description
`ref`	path	oui	Identifiant interne, référence de l'opération, ou votre propre `client_ref`.
`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

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
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