Skip to main content
Utilisez le point de terminaison dédié pour récupérer une liste de paiements. Lister les paiements

Requête

Exemple de requête :
Paramètres de la requête :
  • from : début de la plage de dates, appliquée à la date de création des paiements, ici 2023-01-01T00:00:00.000Z.
  • to : fin de la plage de dates, appliquée à la date de création des paiements, ici 2023-01-01T12:00:00.000Z.
  • page et perPage : permettent de naviguer dans les pages de résultats. perPage vaut 10 par défaut.
  • isDelegated (facultatif) : true ne renvoie que les paiements Processing Only, false uniquement les autres. Lorsque ce paramètre est renseigné, from est obligatoire et la plage de dates doit être inférieure à un an.
Ce point de terminaison est limité à 1 requête toutes les 30 secondes. Au-delà, l’API renvoie HTTP 429 - Too Many Requests.
En cas de trafic élevé, il est impossible de récupérer tous les paiements sans pagination.

Pagination

L’en-tête de réponse Content-Range indique la plage des résultats renvoyés, par exemple 0-99/999999. La valeur après la barre oblique n’est pas le nombre exact de paiements correspondants.
Pour récupérer tous les paiements d’une plage de dates, demandez la page suivante jusqu’à obtenir une page contenant moins de résultats que perPage. Renseignez toujours les filtres de dates, afin que l’ensemble des résultats ne change pas entre deux requêtes.

Réponse

Les résultats sont triés par date de création, par ordre décroissant.
La réponse est un tableau d’objets Payment :