Endpoint responsible for retrieving dunning requests registered in the account in a paginated format, with support for filtering by status, type, charge, and request date range.
Unlike retrieving a specific dunning request, this call returns a list of records that match the filters provided in the request.
Listing behavior
The response from this endpoint is paginated.
This means dunning requests are returned in batches based on the pagination parameters sent in the request. This behavior is important for integrations that perform operational monitoring, administrative routines, or higher-volume queries.
Main request parameters
Some filters are more commonly used in integrations:
offset - Defines the starting element of the list.
limit - Defines the maximum number of elements returned per request. The maximum allowed value is 100.
status - Filters dunning requests by their current status.
Possible statuses include:
PENDINGAWAITING_APPROVALAWAITING_CANCELLATIONPROCESSEDPAIDPARTIALLY_PAIDDENIEDCANCELLED
type - Filters by dunning type.
Possible values are:
CREDIT_BUREAUDEBT_RECOVERY_ASSISTANCE
payment - Filters dunning requests linked to a specific charge.
requestStartDate - Filters from the initial request date onward.
requestEndDate - Filters up to the final request date.
Most common use cases
This endpoint is commonly used to:
- locate dunning requests for a specific charge
- query dunning requests by status
- track open requests
- build administrative dashboards and operational reports
- support internal follow-up and support workflows
-
Important rule for GET requests
GET requestsGET 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.
403Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.
