List payment dunnings

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:

  • PENDING
  • AWAITING_APPROVAL
  • AWAITING_CANCELLATION
  • PROCESSED
  • PAID
  • PARTIALLY_PAID
  • DENIED
  • CANCELLED

type - Filters by dunning type.

Possible values are:

  • CREDIT_BUREAU
  • DEBT_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 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)

string
enum

Filter by payment dunning status

string
enum

Filter by type of payment dunning

Allowed:
string

Filter by dunnings for a specific payment

string

Filter from initial request date

string

Filter from end request date

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