Atualizar cobrança no Asaas, por uma API

Atualiza uma cobrança ainda pendente ou vencida; o cliente não pode ser alterado. Envie billingType, value e dueDate mesmo quando não mudam, com os valores atuais de Get payment. Um novo valor ou vencimento pode notificar o cliente.

Identificador
asaas_update_payment

A chamada

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>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
idstringSimId of the payment, starting with pay_, from List payments or Create payment.
billingTypestringSimHow the customer pays. UNDEFINED lets the payer choose among the methods enabled on the account, on the payment page.Valores: BOLETO, PIX, CREDIT_CARD, UNDEFINED
valuenumberSimAmount in reais, for example 129.9.
dueDatestringSimDue date, in YYYY-MM-DD.
descriptionstringNãoDescription shown to the payer.
externalReferencestringNãoIdentifier of the payment in your own system, usable as a filter in List payments.
discountobjectNãoDiscount for paying early.
interestobjectNãoInterest 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.
fineobjectNãoFine 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.

Conexões possíveis

O seu cliente conecta a conta do Asaas uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/asaas_update_payment. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Asaas

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.