Créer un paiement avec l'API Asaas
Cré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.
- Identifiant
- asaas_create_payment
L'appel
POST https://connect.reportei.com/api/tools/asaas_create_payment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"customer": "<customer>",
"billingType": "BOLETO",
"dueDate": "<dueDate>"
}
}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 | Oui | Id of the customer who pays, starting with cus_, from List customers or Create customer. |
| billingType | string | Oui | How the customer pays. UNDEFINED lets the payer choose among the methods enabled on the account, on the payment page.Valeurs : BOLETO, PIX, CREDIT_CARD, UNDEFINED |
| value | number | Non | Amount in reais, for example 129.9. Required for a one-time payment; for installments, send installmentCount with totalValue or installmentValue instead. |
| dueDate | string | Oui | Due date, in YYYY-MM-DD. For installments, the due date of the first one. |
| description | string | Non | Description shown to the payer. |
| externalReference | string | Non | Identifier of the payment in your own system, usable as a filter in List payments. |
| installmentCount | integer | Non | Number of installments, for a payment in installments. Send it with totalValue or with installmentValue, never both. |
| totalValue | number | Non | Total in reais split into installmentCount installments. Asaas computes each installment and puts any rounding difference in the last one. |
| installmentValue | number | Non | Value in reais of each installment, instead of totalValue. |
| discount | object | Non | Discount for paying early. |
| interest | object | Non | Interest for paying after the due date. Leave it out to keep the interest set on the account, because sending it overrides that setting for this payment. |
| fine | object | Non | Fine for paying after the due date. Leave it out to keep the fine set on the account, because sending it overrides that setting for this payment. |
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_create_payment. 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.
- 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).
- 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