Create payment with the Asaas API

Creates a payment (cobranca) for a customer, by boleto, Pix or credit card, one-time or in installments. The response has invoiceUrl, the payment page to send to the payer, and Asaas may notify the customer according to the customer notification settings.

Identifier
asaas_create_payment

The request

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

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
customerstringYesId of the customer who pays, starting with cus_, from List customers or Create customer.
billingTypestringYesHow the customer pays. UNDEFINED lets the payer choose among the methods enabled on the account, on the payment page.Values: BOLETO, PIX, CREDIT_CARD, UNDEFINED
valuenumberNoAmount in reais, for example 129.9. Required for a one-time payment; for installments, send installmentCount with totalValue or installmentValue instead.
dueDatestringYesDue date, in YYYY-MM-DD. For installments, the due date of the first one.
descriptionstringNoDescription shown to the payer.
externalReferencestringNoIdentifier of the payment in your own system, usable as a filter in List payments.
installmentCountintegerNoNumber of installments, for a payment in installments. Send it with totalValue or with installmentValue, never both.
totalValuenumberNoTotal in reais split into installmentCount installments. Asaas computes each installment and puts any rounding difference in the last one.
installmentValuenumberNoValue in reais of each installment, instead of totalValue.
discountobjectNoDiscount for paying early.
interestobjectNoInterest 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.
fineobjectNoFine 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.

Supported connections

Your customer connects their Asaas account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/asaas_create_payment. It becomes your agent's tool definition with no conversion.

Other Asaas tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.