List payments with the Asaas API

Lists the payments (cobrancas), optionally filtered by customer, subscription, status, billing type, payment date or external reference. Values are in reais. The response has data, totalCount and hasMore; page with offset and limit while hasMore is true.

Identifier
asaas_list_payments

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "customer": "<customer>"
  }
}

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
customerstringNoOnly the payments of this customer, the cus_ id from List customers.
subscriptionstringNoOnly the payments generated by this subscription, the sub_ id from List subscriptions.
statusstringNoOnly the payments in this status. PENDING waits for payment, OVERDUE is past the due date, CONFIRMED is paid by card but not yet credited, and RECEIVED is paid and credited.Values: PENDING, RECEIVED, CONFIRMED, OVERDUE, REFUNDED, RECEIVED_IN_CASH, REFUND_REQUESTED, REFUND_IN_PROGRESS, CHARGEBACK_REQUESTED, CHARGEBACK_DISPUTE, AWAITING_CHARGEBACK_REVERSAL, DUNNING_REQUESTED, DUNNING_RECEIVED, AWAITING_RISK_ANALYSIS
billingTypestringNoOnly the payments of this billing type. UNDEFINED is a payment where the payer chooses the method.Values: UNDEFINED, BOLETO, CREDIT_CARD, PIX
paymentDatestringNoOnly the payments paid on this date, in YYYY-MM-DD.
externalReferencestringNoOnly the payments with this identifier of your own system, saved in externalReference.
offsetintegerNoPosition of the first payment of the page. The default is 0; add limit to it for the next page.
limitintegerNoPayments per page, from 1 to 100. The default is 10.

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_list_payments. 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.