Skip to main content
GET
List the calling client's scheduled payments (ALPHA)

Authorizations

x-api-key
string
header
required

Query Parameters

customer_id
string

Only payments for this customer (the signer's owning agent's customer).

signer_id
string

Only payments bound to this signer.

wallet_id
string

Only payments funded from this wallet.

mandate_id
string

Only payments that executed under this mandate (mandate_id is stamped at fire time, so this matches executed rows only).

mandate_version
integer

Only payments that executed under this VERSION of the mandate — "which payments were judged against v2's caps". Use together with mandate_id; like it, this matches executed rows only.

status
string

Comma-separated statuses to include, e.g. "scheduled,executed". Allowed values: scheduled, cancelled, executed, failed. Omit for all.

limit
integer

Page size. OMIT FOR EVERY MATCHING PAYMENT, which is what this endpoint has always returned and remains the default — a client that does not ask to paginate must not be silently truncated. When you do page, meta.total_count and meta.has_more_after tell you where you are in the collection, so a full page is never mistaken for the end.

Required range: 1 <= x <= 100
page
integer
default:1

1-based page number, used only alongside limit; on its own it has nothing to page through and is ignored. A page past the end is an empty list, not an error.

Rows are ordered by due date DESCENDING and then by id descending — newest due first, so page 1 carries the most recent and upcoming activity rather than the oldest settled history. The id tiebreak makes that order total, so a payment cannot be skipped or repeated across pages by sharing a due date with another.

Required range: x >= 1

Response

Scheduled payments, newest due first

data
object[]
required
meta
object
required

Meta information about the response