Skip to main content
GET
List dashboard payment forecast

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:schedule_date

Payment forecast sort field. Defaults to schedule_date when omitted.

Available options:
schedule_date,
consumer_name,
account_name,
sub_name,
placement_date,
pay_type,
amount
direction
enum<string>
default:asc

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

Response

Dashboard payment forecast rows returned.

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