Payments
2 points d'accès
/v1/paymentsLister les paiements encaissés et leurs pièces
Retourne la liste paginée (curseur v2) des paiements encaissés par le
compte de la clé, de toutes leurs sources : soumissions et
propositions, funnels, paiements notés à la main, paiements Stripe
directs, adhésions à un Espace. Chaque paiement porte ses pièces : son reçu en vigueur et les
notes de crédit de ses remboursements, dont le PDF se lit par
GET /.
Tri stable paid_ : le plus récent encaissé d'abord.
Avec updated_ ou updated_, la liste se trie par
updated_ croissant : un paiement revient quand il est inscrit,
remboursé ou rattaché à une fiche, ou quand une de ses pièces est
émise ou annulée.
Filtres
?contact_(uuid) — les paiements d'une fiche du compte. Une valeur qui n'est pas un UUID répondid 400 invalid_(request details.=field contact_).id
Les paiements en attente ou échoués n'y sont pas : l'événement
payment_ les annonce. Un paiement d'un autre compte n'y
paraît jamais.
payments:readParamètres de requête
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
cursor | string | null | optionnel | Curseur opaque de pagination : passe la valeur de pagination. de la page précédente. |
limit | integer | optionnel | Nombre max de résultats par page (défaut 20, max 100). Au-delà → 400 invalid_request. |
updated_after | string | optionnel | Filtre : uniquement les ressources modifiées après cette date (inclusive). Avec une borne
updated_, la liste se trie par updated_ croissant (la plus ancienne modification d'abord),
départagée par id. Repars de l'updated_ de la dernière ressource lue, moins 2 minutes :
une écriture longue peut porter une date un peu plus ancienne que la fin de ta lecture.
Écarte les doublons par id. Un curseur d'un autre tri est refusé (cursor_).
Une liste qui écarte les ressources archivées (rendez-vous, soumissions) les rend dans cette
lecture avec leur archived_ : c'est ainsi qu'un retrait se lit. |
updated_before | string | optionnel | Filtre : uniquement les ressources modifiées avant cette date (inclusive). Trie la liste comme updated_. |
contact_id | string | optionnel | Uniquement les paiements de cette fiche. |
Réponses
| Statut | Description |
|---|---|
200 | Liste paginée des paiements encaissés. |
400 | Requête invalide.
|
401 | La clé API manque, est inconnue ou a expiré.
|
403 | Refus d'autorisation.
|
429 | Limite de débit atteinte.
|
500 | Erreur serveur inattendue. Toujours fournir le
|
501 | Les clés de test (
|
503 | Un service dont la requête dépend n'a pas répondu (lecture de la clé, du
compte ou du forfait). La même requête passera quand il reviendra :
réessaie après le délai de
|
Exemple de requête
curl -X GET 'https://api.capturia.io/v1/payments' \
-H 'Authorization: Bearer cap_live_<your-key>' \
-H 'Content-Type: application/json'/v1/payment-documents/{id}Lire un reçu ou une note de crédit, avec son PDF
Retourne une pièce d'un paiement du compte : un reçu, ou la note de
crédit d'un remboursement, avec le détail de ses taxes et un lien de
son PDF valable 15 minutes. C'est la lecture qui suit un événement
receipt_ ou credit_, dont data. est
l'identifiant de la pièce.
Un reçu réémis au bon nom nomme celui qu'il remplace
(replaces_), et le reçu remplacé porte replaced_.
Une pièce d'un autre compte est introuvable (404). Si le PDF ne
peut pas être préparé à l'instant, la pièce répond
503 service_ : relis-la après Retry-.
payments:readParamètres de chemin
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
id | string | obligatoire | UUID de la ressource. |
Réponses
| Statut | Description |
|---|---|
200 | La pièce et le lien de son PDF. |
401 | La clé API manque, est inconnue ou a expiré.
|
403 | Refus d'autorisation.
|
404 | Ressource introuvable.
|
429 | Limite de débit atteinte.
|
500 | Erreur serveur inattendue. Toujours fournir le
|
501 | Les clés de test (
|
503 | Un service dont la requête dépend n'a pas répondu (lecture de la clé, du
compte ou du forfait). La même requête passera quand il reviendra :
réessaie après le délai de
|
Exemple de requête
curl -X GET 'https://api.capturia.io/v1/payment-documents/{id}' \
-H 'Authorization: Bearer cap_live_<your-key>' \
-H 'Content-Type: application/json'