List scheduled debits
Returns the payer’s scheduled-debit lifecycle for the account — the “consulta e gerenciamento de pagamentos agendados” of Guia v1.2 §6.4.
It is NOT a forward-only view: a debit stays listed after it leaves SCHEDULED, so SETTLED and CANCELLED entries appear beside the ones still to come. A payer asking why a charge did not happen needs the cancelled row, and the cancellation route needs the id only this listing returns.
An empty page means that the account named in X-Account-Id has no scheduled debit.
This is the ONLY operation that returns a scheduled debit’s id, and POST /v1/payer/scheduled-payments//cancel needs that id. Integrate the two together: list, then cancel by the id an item carries.
Each item carries maximumAmountSnapshot — the ceiling in force when the debit was SCHEDULED, written once and never updated — so a payer who has since changed the ceiling can see why an existing debit still reflects the old one. Returning it here is the payer’s own authenticated channel; Guia v1.2 §6.1 bars sharing it with the RECEIVING user and their PSP, which this surface is not.
Ordering is by scheduledDate and then by id, which is also what the cursor resumes on — not the write instant, unlike the three sibling listings. authorizationId is absent on a debit scheduled without a mandate (purpose RIFL), and maximumAmountSnapshot is absent when no ceiling was in force; neither absence is an error.
Paging is by cursor. On the last page next_cursor is null, never an empty string.
Autorizações
JWT bearer token issued by the identity provider.
Cabeçalhos
Non-zero UUID of the payer account selected by the calling PSP. The PSP must authorize its end user for that account before calling this API. A resource outside the selected account returns 404; a read with no records returns an empty page. See the API overview for the complete trust boundary.
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$Parâmetros de consulta
Maximum number of records per page (1-100, default 10). A value outside that range, or one that is not an integer, is REFUSED — never clamped, never silently coerced.
1 <= x <= 100Opaque cursor taken from a previous page's next_cursor. On the last page that value is null, never an empty string. A malformed or undecodable value is refused with 400. The cursor must be replayed against the same endpoint, with the same sort_order and the same filters used to obtain it; changing any of those starts a different query, and the previous cursor should not be reused.
"eyJ0IjoiMjAyNi0wOC0yN1QxODo0MjowMFoiLCJpIjoiMDE5OGYzYTEtN2M0Mi03ZGUxLWEwMjQtYjFmMGI3ZTljMzAxIn0="
Sort direction. An unrecognised value is refused rather than silently defaulted, because switching it mid-traversal without notice would silently reverse the page sequence the caller is walking.
asc, desc "desc"
Resposta
A page of scheduled debits, newest settlement date first. Empty when the account named in X-Account-Id has none.
Empty array when there are no results — never null. An empty array means the account named in X-Account-Id has no scheduled debit.
Opaque cursor for the next page. NULL on the last page, never an empty string.
"eyJ0IjoiMjAyNi0wOC0yN1QxODo0MjowMFoiLCJpIjoiMDE5OGYzYTEtN2M0Mi03ZGUxLWEwMjQtYjFmMGI3ZTljMzAxIn0="
Opaque cursor for the previous page. These listings do not issue a backwards cursor, so the value is null.