Répartitions

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
GET	/v1/payments/{id}/splits	Les parts d'un encaissement
POST	/v1/payments/{id}/splits	Répartir un encaissement

GET /v1/payments/{id}/splits

Les parts d'un encaissement

Les parts déjà attribuées, avec leur état de règlement.

Paramètres

Nom	Emplacement	Requis	Description
id	path	oui

Réponses

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

POST /v1/payments/{id}/splits

Répartir un encaissement

Attribue des parts d'un encaissement réussi à d'autres comptes de la plateforme — le geste d'une marketplace qui reverse à ses vendeurs.

⚠️ LA RÉPARTITION EST INSCRITE DANS LA MÊME TRANSACTION QUE L'ENCAISSEMENT, ce qui rend impossible de répartir plus qu'il n'a été collecté : le parent est revalidé sous verrou et l'ensemble est refusé plutôt qu'une partie. Une marketplace qui répartirait en deux temps aurait à gérer « encaissé mais pas encore réparti » ; cet état n'existe pas ici.

fee_minor est PRÉLEVÉ SUR amount_minor, pas ajouté par-dessus : le bénéficiaire reçoit amount − fee.

Paramètres

Nom	Emplacement	Requis	Description
id	path	oui	L'encaissement à répartir : identifiant, référence, ou votre client_ref.
Idempotency-Key	header	non	Clé d'idempotence propre à CETTE opération.

Corps de la requête

Champ	Type	Requis	Description
splits	object[]	oui
splits[].beneficiary_id	string	oui	Le compte bénéficiaire, par son identifiant PUBLIC. Il doit être actif, et ne peut pas être le vôtre.
splits[].amount_minor	string	oui	Montant en UNITÉS MINEURES, en chaîne de caractères. Le nombre de décimales de l'actif est donné par GET /v1/assets.
splits[].fee_minor	string	non	Votre commission sur cette part. Absent = 0.
splits[].description	string	non

Réponses

• 201 — Parts créées (object)
• 401 — Clé API manquante ou rejetée (Error)
• 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif (Error)
• 404 — Aucun encaissement de cet identifiant pour ce compte (Error)
• 422 — Bénéficiaire inconnu ou inactif, bénéficiaire égal à vous-même, opération non encaissée, ou total supérieur au parent (Error)
• 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After (Error)

Schémas

Les formes renvoyées par les opérations ci-dessus.

Error

Champ	Type	Description
error	object
error.code	string
error.message	string