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ètreTypeObligatoireDescription
customerstringOuiId of the customer who pays, starting with cus_, from List customers or Create customer.
billingTypestringOuiHow 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
valuenumberNonAmount in reais, for example 129.9. Required for a one-time payment; for installments, send installmentCount with totalValue or installmentValue instead.
dueDatestringOuiDue date, in YYYY-MM-DD. For installments, the due date of the first one.
descriptionstringNonDescription shown to the payer.
externalReferencestringNonIdentifier of the payment in your own system, usable as a filter in List payments.
installmentCountintegerNonNumber of installments, for a payment in installments. Send it with totalValue or with installmentValue, never both.
totalValuenumberNonTotal in reais split into installmentCount installments. Asaas computes each installment and puts any rounding difference in the last one.
installmentValuenumberNonValue in reais of each installment, instead of totalValue.
discountobjectNonDiscount for paying early.
interestobjectNonInterest 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.
fineobjectNonFine 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

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.