> ## 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 an SLB payment > Reads a payment this participant commanded — either kind — by its correlation id. PENDING until BACEN's answer arrives AND that answer reports a settlement: an answer carrying a pending-class situation reports that the entry was taken and not yet settled, and is recorded as such rather than read as payment. ## OpenAPI ````yaml /pt/openapi/v3-current/spb.yaml get /v1/str/slb-payments/{nuOp} openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- OpenAPI 3.1 surface for Lerian SPB, the direct integration between the institution and the Brazilian Payment System (SPB) over the National Financial System Network (RSFN). It covers the Reserve Transfer System (STR): message registry and capability catalog, operation lifecycle (bank transfers, IBS repasses, liquidity transfers, returns and cancellations), reserve-account and schedule queries, alçada governance, SME and LDL operations, inbound quarantine triage, reconciliation, and event delivery. license: name: Lerian Studio General License title: Lerian SPB API version: 1.0.0 servers: - url: https://spb.sandbox.lerian.net security: [] tags: - description: Immutable audit-record trails for STR operations and lifecycle events. name: Audit - description: >- STR capability catalog describing supported message types and their constraints. name: Capabilities - description: >- ICP-Brasil certificate inventory with hot-reloadable rotation and activation. name: Certificates - description: >- STR compulsory-movement (RCO) family: the movements BACEN orders on a participant's reserve account, their answers and the periods they belong to. name: Compulsory - description: >- Maker-checker approval queue for emissions parked above their alçada band: list pending, sign (approve), and deny. name: EmissionApprovals - description: Webhook event-delivery records with retry control for failed dispatches. name: EventDeliveries - description: Operation event catalog enumerating the emitted domain event types. name: Events - description: >- Inbound GEN-family notice log (GEN0001 connectivity echo, GEN0004 transmission error, GEN0005 administrative notice). name: GenNotices - description: >- SPB alçada governance config: value-band table + per-message-type signature requirements, hot-reloaded at runtime. name: Governance - description: >- Read raw STR message status: list messages and read a single message by NUOp. name: Messages - description: Aggregated operational summaries and metrics across STR operations. name: OperationalIntelligence - description: >- STR operation lifecycle for bank transfers and IBS repasses, including returns and cancellations. name: Operations - description: >- Service readiness state covering startup self-probes and dependency health. name: Readiness - description: Reconciliation cases and the actions that resolve operation discrepancies. name: Reconciliation - description: >- Redesconto do Banco Central: collateralised intraday and one-business-day BCB lending against Selic-registered federal securities. One create door derives the nine RDC commands from four operator-facing kinds (contract, payment, conversion, cancellation), plus the two consultas over eligible-security prices and open positions. An accepted rediscount is not necessarily a settled one — Selic may hold the request for want of securities, and that middle state is reported as its own. name: Rediscounts - description: >- STR Relatórios suite: synchronous, date-ranged aggregate reports (movimento financeiro, transações rejeitadas, volumetria) over Lerian SPB's own transmission record. name: Reports - description: >- STR0013 reserve-account balance and STR0014 statement (extrato, message-mode) queries and their async results. name: ReserveQueries - description: >- GEN0019 participant responsável roster: full-replacement updates announced to BACEN. name: Responsibles - description: STR operating-window schedule governing when operations may be sent. name: Schedule - description: >- STR0001 single-party schedule queries (consulta de horários do STR) and their async STR0001R1 grid results. name: ScheduleQueries - description: >- STR lançamentos (SLB) family: the charges BACEN raises against this participant, the payments that settle them, payments to BACEN it never demanded, and the entry consultas over them. name: SLB - description: >- Reads over an IEME's conta correspondente a moeda eletrônica (CCME): SME0003 statement (extrato) queries and their async SME0003R1 results, plus the log of SME0001R2/SME0002R2/SME0004R2 movement advices the STR delivered about movements this rail did not command. name: SMEQueries - description: Runtime SPB configuration settings for the STR integration. name: Settings - description: Webhook endpoint registration and management for event delivery. name: Webhooks - description: >- Flow (mandatory order): certificate → readiness → connectivity-test → submit. Activate a certificate, confirm the rail reports ready, pass a connectivity test, then submit an operation. Each step is its own resource; a submit must not be attempted before readiness passes. name: onboarding - description: >- Flow (mandatory order): parent operation SETTLED → return/cancel. A return or cancellation is a sub-resource of a settled parent operation; the {operationId}/{endToEndID} path segment enforces the parent structurally. name: lifecycle paths: /v1/str/slb-payments/{nuOp}: get: tags: - SLB summary: Read an SLB payment description: >- Reads a payment this participant commanded — either kind — by its correlation id. PENDING until BACEN's answer arrives AND that answer reports a settlement: an answer carrying a pending-class situation reports that the entry was taken and not yet settled, and is recorded as such rather than read as payment. operationId: getSLBPayment parameters: - description: >- Correlation id returned by POST /v1/str/slb-payments or POST /v1/str/slb-bacen-payments (the outbound NUOp; 23 characters: ISPB[8]+DATE[8]+SEQ[7]). in: path name: nuOp required: true schema: description: >- Correlation id returned by POST /v1/str/slb-payments or POST /v1/str/slb-bacen-payments (the outbound NUOp; 23 characters: ISPB[8]+DATE[8]+SEQ[7]). maxLength: 23 minLength: 23 pattern: ^[0-9A-Z]{8}[0-9]{15}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SLBPaymentResponse' description: OK '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '429': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Too Many Requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: SLBPaymentResponse: additionalProperties: false properties: agreementCnpj: description: Agreement CNPJ (CNPJConv), verbatim. examples: - '00038166000105' type: string amount: description: Payment amount (VlrLanc), verbatim as text — never parsed or summed. examples: - '1500.00' type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e type: string description: description: Free text (Hist). Present on SLB0007 only — SLB0002 declares none. examples: - DEVOLUCAO DE CREDITO type: string id: description: Correlation id (the outbound NUOp). examples: - '46026562202609150000001' type: string movementDate: description: Business date (DtMovto) stamped on the frame. examples: - '2026-09-15' type: string numCtrlPart: description: This participant's own control number for the payment. examples: - '20260915000000000001' type: string numCtrlSLB: description: >- Entry BACEN minted for the payment, from an SLB0007R1. Blank on the SLB0002 path, where the entry already existed. examples: - SLB20260915000000020 type: string numCtrlSTR: description: STR entry the settlement rode, verbatim. examples: - STR20260915000000009 type: string originalControlNumber: description: >- On SLB0002, the charge being paid (mandatory). On SLB0007, the SLB0005 credit being returned (optional). examples: - SLB20260915000000001 type: string preferenceLevel: description: Processing preference (NivelPref), verbatim. examples: - '0001' type: string purpose: description: >- BACEN finalidade code (FinlddSLB). Present on SLB0007 only — SLB0002 declares none. examples: - '01' type: string rejectionReason: description: Operator-facing text of a refusal, verbatim. examples: - saldo insuficiente type: string settledAt: description: >- RFC3339 UTC timestamp the payment became terminal. Empty while PENDING. examples: - '2026-09-15T18:00:01Z' format: date-time type: string sitLancSLB: description: >- Situation code the answer carried, verbatim. It is BACEN's word on the entry, and it — not the fact that we sent the request — is what decides the status above. examples: - '1' type: string status: description: >- PENDING until an answer arrives AND that answer reports a settlement. An answer carrying a pending-class situation (the entry was taken, not yet settled) leaves this PENDING with sitLancSLB recorded — it is never read as payment. enum: - PENDING - SETTLED - REJECTED - CANCELLED examples: - PENDING type: string wireCode: description: >- SLB0002 pays a charge BACEN raised; SLB0007 pays BACEN an amount SLB never demanded. enum: - SLB0002 - SLB0007 examples: - SLB0002 type: string required: - id - wireCode - numCtrlPart - amount - movementDate - status - correlationId type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e 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. required: - correlationId 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 ````