Kiwify icon

Kiwify

Interagir com a API da Kiwify

Overview

The "Listar Saques" operation of the Kiwify node interacts with the Kiwify API to retrieve a paginated list of payout transactions (saques). This operation is useful for users who want to monitor or manage payouts made from their Kiwify account, optionally filtering by legal entity.

Typical use cases include:

  • Fetching recent payout records for reconciliation or accounting.
  • Filtering payouts by specific legal entities to track payments per entity.
  • Paginating through large sets of payout data to process or display in batches.

For example, an e-commerce platform using Kiwify can automate fetching all payouts made in the last month, filtered by a particular legal entity ID, and then update their internal financial system accordingly.

Properties

Name Meaning
Legal Entity ID Optional filter to retrieve payouts only for a specific legal entity ID.
Tamanho Da Página Number of payout records to return per page (pagination size).
Número Da Página The page number of results to retrieve (pagination index).

Output

The output is a JSON array where each item represents a payout record retrieved from the Kiwify API. Each payout object typically contains details such as payout amount, date, status, and associated legal entity information.

No binary data is returned by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kiwify API.
  • The node uses OAuth token retrieval internally via client ID and secret provided in credentials.
  • Requires network access to https://public-api.kiwify.com/v1/payouts endpoint.
  • The user must configure the node with valid Kiwify API credentials including client ID, client secret, and account ID.

Troubleshooting

  • Authentication errors: If the node fails to authenticate, verify that the API credentials (client ID, client secret, and account ID) are correct and have sufficient permissions.
  • Empty results: If no payouts are returned, check if the filters (legal entity ID, page size, page number) are set correctly and that there are payouts matching those criteria.
  • Pagination issues: Ensure that the page number and page size parameters are within valid ranges supported by the API.
  • API rate limits or downtime: Temporary failures may occur due to API limits or service interruptions; retry after some time or check Kiwify service status.

Common error messages will be propagated from the API response and surfaced in the node's error output when "Continue On Fail" is disabled.

Links and References

Discussion