> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Read a recurring series' receipt > Returns the proof of what the payer committed to when they created the series: when it was registered, the amount of each payment, the first payment date, the frequency, the number of payments when one was chosen, and the last payment date when the series has one. It is a DIFFERENT document from the single schedule's receipt and shares no field with it -- a series has no settlement date of its own and a single schedule has no frequency, so one shared schema would leave half the fields null on either side. paymentCount and lastPaymentDate are null on an indefinite series, where stating either would be a fabrication. cancellationCutoff is the deadline of the NEXT pending occurrence, because a cut-off belongs to a date and a series spans many; it is null when no occurrence is pending. The receipt carries no status and no history on purpose -- a document people save should not go stale the moment the series moves. ## OpenAPI ````yaml /en/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-recurrences/{recurrence_id}/receipt openapi: 3.1.0 info: contact: name: Lerian Studio url: https://lerian.studio description: Public API for outbound Pix transfers, refunds, and scheduled payments. license: name: Lerian Studio General License title: Pix Lerian — Payments version: 1.1.0 servers: - url: https://api.example.com/spi/v1 description: >- Replace the example host with the URL provided during environment onboarding. security: - BearerAuth: [] tags: - description: Create, list, and retrieve Pix refunds. name: Refunds - name: Scheduled Payments description: Register, list, retrieve, and cancel scheduled Pix payments. - description: Initiate, process, list, and retrieve outbound Pix transfers. name: Transfers - description: >- Register, list, retrieve, and cancel recurring series of scheduled Pix payments. name: Scheduled Payment Recurrences paths: /scheduled-payment-recurrences/{recurrence_id}/receipt: get: tags: - Scheduled Payment Recurrences summary: Read a recurring series' receipt description: >- Returns the proof of what the payer committed to when they created the series: when it was registered, the amount of each payment, the first payment date, the frequency, the number of payments when one was chosen, and the last payment date when the series has one. It is a DIFFERENT document from the single schedule's receipt and shares no field with it -- a series has no settlement date of its own and a single schedule has no frequency, so one shared schema would leave half the fields null on either side. paymentCount and lastPaymentDate are null on an indefinite series, where stating either would be a fabrication. cancellationCutoff is the deadline of the NEXT pending occurrence, because a cut-off belongs to a date and a series spans many; it is null when no occurrence is pending. The receipt carries no status and no history on purpose -- a document people save should not go stale the moment the series moves. operationId: getScheduledPaymentRecurrenceReceipt parameters: - description: Series identifier. in: path name: recurrence_id required: true schema: description: Series identifier. examples: - 01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0 format: uuid type: string responses: '200': content: application/json: example: recurrenceId: 01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0 scheduledAt: '2026-09-25T14:32:10.123456Z' amount: '150.00' firstPaymentDate: '2027-08-10' periodicity: MONTHLY paymentCount: 12 lastPaymentDate: '2028-07-10' payer: branch: '0001' accountNumber: '1234567' accountType: CACC ispb: '60746948' personType: NATURAL_PERSON taxId: '12345678909' name: Ana Souza payee: branch: '0001' accountNumber: '7654321' accountType: CACC ispb: '18236120' personType: NATURAL_PERSON taxId: '98765432100' name: Joao Pereira description: Aluguel metadata: contractRef: A-4471 cancellationCutoff: '2027-08-10T02:59:59.999999Z' schema: $ref: '#/components/schemas/RecurrenceReceiptView' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- recurrence_id is not a UUID (PIX-0015). The response names the parameter; the series is never looked up. '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- No series with that identifier exists for this organization (PIX-0760). A series belonging to another organization answers this too: the read is scoped by organization, and distinguishing the two cases would only help someone probing the identifier space. An identifier that is not a UUID is a DIFFERENT answer -- the binding contract refuses it with 400 before the query runs, and the response names the field. '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: RecurrenceReceiptView: additionalProperties: false properties: amount: description: Amount of every occurrence, in BRL. examples: - '150.00' type: string cancellationCutoff: description: >- Deadline to cancel the NEXT pending occurrence. A cut-off belongs to a date and a series spans many, so this is the one field here that is not a property of the series itself. Null when no occurrence is pending -- there is then nothing left to cancel in the materialized window. format: date-time type: - string - 'null' description: description: The payer's memo, exactly as stored. examples: - Aluguel type: string firstPaymentDate: description: Civil date of the first payment. examples: - '2027-08-10' format: date type: string lastPaymentDate: description: >- Civil date of the final payment, when the series has one. Null on an indefinite series. examples: - '2028-07-10' format: date type: - string - 'null' metadata: additionalProperties: {} description: The annotation the caller sent at creation, returned verbatim. examples: - contractRef: A-4471 type: object payee: $ref: '#/components/schemas/ParticipantView' description: The payee as photographed at creation. payer: $ref: '#/components/schemas/ParticipantView' description: The payer as photographed at creation. paymentCount: description: >- How many payments the series has in all, when the payer terminated it by count. Null otherwise -- an indefinite series has no total, and reporting one would be a fabrication. examples: - 12 format: int64 type: - integer - 'null' periodicity: description: How often the series pays. enum: - WEEKLY - MONTHLY examples: - MONTHLY type: string recurrenceId: description: Series identifier. examples: - 01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0 type: string scheduledAt: description: When the series was registered. format: date-time type: string required: - recurrenceId - scheduledAt - amount - firstPaymentDate - periodicity - paymentCount - lastPaymentDate - payer - payee - cancellationCutoff type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object ParticipantView: additionalProperties: false properties: accountNumber: examples: - '123456' type: string accountType: enum: - CACC - SVGS - TRAN - SLRY examples: - CACC type: string branch: examples: - '0001' type: string ispb: description: 8-digit BACEN participant identifier. examples: - '32074986' type: string name: examples: - Ana Souza type: string personType: enum: - NATURAL_PERSON - LEGAL_PERSON examples: - NATURAL_PERSON type: string taxId: description: CPF or CNPJ, digits only. examples: - '39053344705' type: string required: - accountType - ispb - personType - taxId - name type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.