Lister les paiements avec l'API Asaas
Liste les paiements (cobrancas), avec filtre optionnel par client, abonnement, statut, mode de paiement, date de paiement ou référence externe. Les montants sont en reais. La réponse contient data, totalCount et hasMore ; paginez avec offset et limit tant que hasMore vaut true.
- Identifiant
- asaas_list_payments
L'appel
POST https://connect.reportei.com/api/tools/asaas_list_payments/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"customer": "<customer>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| customer | string | Non | Only the payments of this customer, the cus_ id from List customers. |
| subscription | string | Non | Only the payments generated by this subscription, the sub_ id from List subscriptions. |
| status | string | Non | Only the payments in this status. PENDING waits for payment, OVERDUE is past the due date, CONFIRMED is paid by card but not yet credited, and RECEIVED is paid and credited.Valeurs : PENDING, RECEIVED, CONFIRMED, OVERDUE, REFUNDED, RECEIVED_IN_CASH, REFUND_REQUESTED, REFUND_IN_PROGRESS, CHARGEBACK_REQUESTED, CHARGEBACK_DISPUTE, AWAITING_CHARGEBACK_REVERSAL, DUNNING_REQUESTED, DUNNING_RECEIVED, AWAITING_RISK_ANALYSIS |
| billingType | string | Non | Only the payments of this billing type. UNDEFINED is a payment where the payer chooses the method.Valeurs : UNDEFINED, BOLETO, CREDIT_CARD, PIX |
| paymentDate | string | Non | Only the payments paid on this date, in YYYY-MM-DD. |
| externalReference | string | Non | Only the payments with this identifier of your own system, saved in externalReference. |
| offset | integer | Non | Position of the first payment of the page. The default is 0; add limit to it for the next page. |
| limit | integer | Non | Payments per page, from 1 to 100. The default is 10. |
Connexions possibles
Votre client connecte son compte Asaas une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/asaas_list_payments. Il devient la définition de tool de votre agent sans conversion.
Autres tools Asaas
- Lister les clientsGETListe les clients (payeurs) du compte, avec filtre optionnel par nom, e-mail, CPF ou CNPJ, groupe ou référence externe. La réponse contient data, totalCount et hasMore ; paginez avec offset et limit tant que hasMore vaut true.
- Consulter un clientGETRenvoie un client, avec nom, CPF ou CNPJ, e-mail, téléphones, adresse et paramètre de notification.
- Créer un clientPOSTCrée un client, le payeur des paiements et abonnements. name et cpfCnpj sont obligatoires. Il n'y a pas de champ ville : Asaas déduit la ville de postalCode.
- Mettre à jour un clientPUTMet à jour un client. Les champs non envoyés restent inchangés.
- Consulter un paiementGETRenvoie un paiement, avec statut, montant, montant net, échéance, date de paiement et les liens invoiceUrl (la page du paiement) et bankSlipUrl (le boleto).
- Créer un paiementPOSTCrée un paiement (cobranca) pour un client, par boleto, Pix ou carte de crédit, en une fois ou en plusieurs fois. La réponse contient invoiceUrl, la page de paiement à envoyer au payeur, et Asaas peut notifier le client selon ses paramètres de notification.
- Mettre à jour un paiementPUTMet à jour un paiement encore en attente ou en retard ; le client ne peut pas changer. Envoyez billingType, value et dueDate même s'ils ne changent pas, avec les valeurs actuelles de Get payment. Un nouveau montant ou une nouvelle échéance peut notifier le client.
- Supprimer un paiementDELETESupprime un paiement, qui ne peut plus être réglé ; il peut être restauré dans Asaas. Il ne rembourse pas un montant déjà payé, et supprimer un paiement d'abonnement ne met pas fin à l'abonnement.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.

Conta Azul