Mettre à jour un paiement avec l'API Asaas

Met à 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.

Identifiant
asaas_update_payment

L'appel

POST https://connect.reportei.com/api/tools/asaas_update_payment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>",
    "billingType": "BOLETO",
    "value": 1,
    "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
idstringOuiId of the payment, starting with pay_, from List payments or Create payment.
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
valuenumberOuiAmount in reais, for example 129.9.
dueDatestringOuiDue date, in YYYY-MM-DD.
descriptionstringNonDescription shown to the payer.
externalReferencestringNonIdentifier of the payment in your own system, usable as a filter in List payments.
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_update_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.