Tools Asaas
Les 12 opérations Asaas que votre produit exécute sur le compte de votre client via Connect. Elles utilisent toutes le même endpoint, POST /api/tools/{tool}/execute.
- 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.
- Lister les paiementsGETListe 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.
- 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.
- Lister les abonnementsGETListe les abonnements, avec filtre optionnel par client, statut, mode de paiement ou référence externe. Les paiements générés par un abonnement viennent de List payments avec le filtre d'abonnement. Paginez avec offset et limit tant que hasMore vaut true.
- Créer un abonnementPOSTCrée un abonnement pour un client, qui génère un paiement par cycle, le premier à l'échéance nextDueDate. Les paiements apparaissent dans List payments avec le filtre d'abonnement.
- Mettre à jour un abonnementPUTMet à jour un abonnement. Les changements s'appliquent aux paiements pas encore générés, sauf si updatePendingPayments vaut true. status INACTIVE suspend l'abonnement et garde ses paiements, et ACTIVE le réactive avec un nouveau nextDueDate.
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