Skip to main content
GET
List payment schedules

Authorizations

Authorization
string
header
required

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

Query Parameters

payment_schedule_id
string<uuid>[]
originating_customer
string<uuid>[]
to_next_schedule_date
string<date-time>
receiving_account
string<uuid>[]
to_next_execution_date
string<date-time>
receiving_customer
string<uuid>[]
description_like
string

Case insensitive wildcard search for description, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

from_next_schedule_date
string<date-time>
account_id
string<uuid>[]
from_creation_time
string<date-time>
description
string[]
from_last_updated_time
string<date-time>
from_next_execution_date
string<date-time>
in_queue
boolean
to_last_updated_time
string<date-time>
tenant
string[]

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

originating_account
string<uuid>[]
sort_by
enum<string>[]
Available options:
creation_time:asc,
creation_time:desc,
payment_type:asc,
payment_type:desc
status
enum<string>[]

Status of the payment schedule.

Available options:
ACTIVE,
CANCELLED,
ERRORED,
EXPIRED
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

to_creation_time
string<date-time>
customer_id
string<uuid>[]
id
string<uuid>[]

Response

List of payment schedules

payment_schedules
object[]
required

Array of payment schedules.

next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"