List payments available for payment dunning

Returns a paginated list of possible negative charges together with a simulation of values for each type of negative.

Endpoint responsible for retrieving charges eligible for dunning.

This call returns a paginated list of charges that can be submitted for dunning, along with a value simulation for each available dunning type.


Listing behavior

The response from this endpoint is paginated.

In addition to identifying which charges can proceed to dunning, this call is also useful for supporting decision-making before the actual request is submitted, since it provides a simulation of the amounts involved.


Pagination parameters

offset - Defines the starting element of the list.

limit - Defines the maximum number of elements returned per request.


When to use this endpoint

This endpoint is useful in scenarios such as:

  • identifying charges eligible for dunning
  • building operational review queues
  • displaying dunning opportunities in administrative interfaces
  • validating cost or applicable type before request creation

Important rule for GET requests

GET requests must be sent with an empty body.

If the integration sends content in the request body, the API may return a 403 Forbidden error.

Query Params
integer

List starting element

integer
≤ 100

Number of list elements (max: 100)

Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json