Règlements
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/settlements |
Lister les règlements |
GET |
/v1/settlements/{id} |
Consulter un règlement |
GET /v1/settlements
Lister les règlements
Les versements de vos encaissements vers votre compte de règlement, avec la période couverte et le montant net.
ⓘ Servi par le modèle de lecture, sur un réplica.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
page |
query | non | |
per_page |
query | non | |
status |
query | non | Filtre sur le statut du règlement. |
Réponses
200— OK401— Clé API manquante ou rejetée (Error)403— La clé ne porte pas le scope requis, ou le compte n'est pas actif (Error)429— Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After (Error)
GET /v1/settlements/{id}
Consulter un règlement
Le règlement et les opérations qu'il couvre.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id |
path | oui | L'identifiant du règlement. |
Réponses
200— OK401— 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 règlement de cet identifiant (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 |