Read one recurring series
Returns the series — its rule, both parties as photographed at creation, and the window edge — together with the occurrences currently materialized for it, oldest first. The list is empty and never null, and it is a WINDOW rather than the whole calendar: materializedThrough says how far it reaches, and a long-running series is enumerated in full through GET /v1/scheduled-payments with recurrence_id. A series belonging to another organization answers 404 rather than 403: the read is scoped by organization, so the row is never seen, and answering ‘forbidden’ would confirm the identifier exists.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
Series identifier.
"01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0"
Response
OK
Payer account.
"0195948b-bf02-7e4f-9a1b-2c3d4e5f6a7b"
Amount of every occurrence, in BRL.
"150.00"
Always BRL.
"BRL"
The payee as photographed at creation. On a DICT series it is compared, before EVERY occurrence settles, against a fresh directory answer (REG-Art.9 section 6), which is why it is stored rather than re-resolved; the occurrences of a MANUAL series are sent to it as photographed, with no second lookup.
Series identifier.
"01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0"
How the destination was resolved at creation.
MANUAL, DICT, QR_CODE "DICT"
Civil date of the series' final payment, when it has one. Null on an indefinite series, where reporting one would be a fabrication.
"2028-07-10"
Civil date up to which occurrences exist -- the edge of the materialized window. Occurrences beyond it do not exist yet. Null on a series that has never been materialized.
"2027-10-10"
The currently materialized occurrences, oldest first -- NOT necessarily the whole series. materializedThrough states how far the window reaches, and a long-running series is enumerated in full through GET /v1/scheduled-payments?recurrence_id=. Empty and never null.
Always IPAY: REG-Art.11-P prohibits scheduling any other purpose.
IPAY "IPAY"
The rule the occurrences are computed from.
The payer as photographed at creation.
Situation of the SERIES, not of any one occurrence: a cancelled series still has settled occurrences behind it, and each occurrence carries its own status.
ACTIVE, COMPLETED, CANCELLED "ACTIVE"
The payer's memo, carried by every occurrence and returned exactly as stored.
"Aluguel"
The annotation the caller sent at creation, returned verbatim. Absent when none was sent -- this service never invents one.
The directory key a DICT-initiated series resolved at creation. It is kept because the mandatory re-lookup needs the key that was used, and a key is not one of the payee's attributes -- it cannot be reconstructed from the photograph above.