Skip to main content
GET
List dashboard failed payments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

Search consumer full name, member account number, or original account number.

Maximum string length: 255
sort
enum<string>
default:due_date

Failed payments sort field. Defaults to due_date when omitted.

Available options:
due_date,
last_failed_date,
account_number,
consumer_name,
account_name,
sub_account_name,
placement_date,
pay_type,
amount
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
page
integer
default:1

Page number for paginated list responses.

Required range: x >= 1
per_page
integer
default:25

Number of records per page.

Required range: 1 <= x <= 100
window
integer
default:30

Rolling day window applied to the last failed date. Defaults to 30 days.

Required range: x >= 1

Response

Dashboard failed payment rows returned.

data
object[]
required
pagination
object
required
Last modified on July 20, 2026