components: schemas: AcknowledgeAlertInputBody: additionalProperties: false properties: note: description: Optional operator note recorded with the acknowledgement (≤500 characters). maxLength: 500 type: string type: object AdviceListResponse: additionalProperties: false properties: hasMore: description: Whether a further page exists. type: boolean items: description: The advices on this page, newest movement date first (never null; empty when none match). items: $ref: "#/components/schemas/AdviceResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object AdviceResponse: additionalProperties: false properties: advisedAt: description: The câmara's own clock (DtHrLDL, or DtHrSit on LDL1027), verbatim. Omitted on LDL1018, whose layout carries no timestamp element at all. format: date-time type: string body: additionalProperties: {} description: This code's own fields, exactly as the câmara sent them. Amounts are decimal STRINGS, never numbers, so no precision is lost on the way through. Repeating groups are arrays in wire order. type: object codMsg: description: The message code the câmara declared, e.g. LDL0001. It selects the shape of body. type: string codProdt: description: The SILOC product. None of these layouts declares the element, so it is omitted rather than fabricated. type: string id: description: Stored advice id. format: uuid type: string ispbIF: description: This institution's ISPB, as the body declared it. type: string ispbLDL: description: The câmara's ISPB, as the body declared it. type: string movementDate: description: Data Movimento, the business date this advice belongs to. format: date type: string numCtrlLDL: description: Número Controle LDL, the câmara's own identifier for this advice. It is the key a confirmation leg echoes (LDL0003 answers an LDL0001 by it, LDL1019 an LDL1018). type: string nuop: description: The BCMSG operation number of the frame this row was projected from, so a stored advice traces back to the delivered message. type: string receivedAt: description: When this rail stored the row. format: date-time type: string required: - id - codMsg - numCtrlLDL - ispbLDL - ispbIF - nuop - movementDate - body - receivedAt type: object AdvisoryListResponse: additionalProperties: false properties: hasMore: description: Whether more advisories exist beyond this page. type: boolean items: description: The page of advisories (never null; empty when none). items: $ref: "#/components/schemas/AdvisoryResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the feed is exhausted. type: string required: - items - hasMore type: object AdvisoryResponse: additionalProperties: false properties: announcedAt: description: The câmara's OWN announced instant (DtHrLDL), verbatim. format: date-time type: string cnpjEntRespons: description: CNPJ of the Entidade Responsável the câmara addressed — who the advisory must be forwarded to. type: string codMsg: description: LDL1001 (exigibilidade de colateral), LDL1011 (ativos a substituir) or LDL1014 (alteração na lista de elegíveis). type: string details: description: Every field below the shared header, exactly as the câmara sent it. Amounts and quantities are wire strings, never parsed into numbers. id: description: Advisory id. format: uuid type: string ispbIF: description: This institution's ISPB; omitted on LDL1014, whose layout carries none. type: string ispbLDL: description: The announcing câmara's ISPB. type: string movementDate: description: Movement date (DtMovto), YYYY-MM-DD. type: string numCtrlLDL: description: The câmara's own control number for this advisory. type: string nuop: description: BCMSG unique operation number of the frame this row was projected from. type: string receivedAt: description: When this rail stored the advisory. format: date-time type: string required: - id - codMsg - numCtrlLDL - ispbLDL - cnpjEntRespons - details - announcedAt - movementDate - nuop - receivedAt type: object AlertListResponse: additionalProperties: false properties: hasMore: description: Whether more alerts exist beyond this page. type: boolean items: description: The page of alerts (never null; empty when nothing matches). items: $ref: "#/components/schemas/AlertResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the feed is exhausted. type: string required: - items - hasMore type: object AlertResponse: additionalProperties: false properties: active: description: Whether the alert is active. false appears only when activeOnly=false surfaces deactivated (history) alerts. type: boolean complementWindowClosesAt: description: For a RECALCULATION alert whose cycle holds an active recálculo round, the round's complement/deposit deadline, projected verbatim from ot_recalculations.complement_window_closes_at; omitted otherwise. format: date-time type: string cycleId: description: Correlated cycle id; omitted for a connection-level alert (e.g. RELAY_DOWN). format: uuid type: string deadlineAt: description: Absolute deadline this alert tracks (e.g. a WINDOW_CLOSING deposit close or a CERTIFICATE_EXPIRY not-after), projected verbatim from alerts.deadline_at; omitted when the stored column is NULL. format: date-time type: string details: description: "Structured payload of an accumulating alarm, projected verbatim from alerts.details; omitted when the stored column is NULL. An INBOUND_SEMANTIC_REJECTED alert keeps ONE row for a whole episode and carries count, lastCodMsg, lastReason, lastRowId and lastAt here, so this is the only place the size of that episode is visible. An UNANSWERED_REQUEST alert carries the request it names: outboundMessageId, codMsg, numCtrlIf and dispatchedAt; the deadline that was crossed is deadlineAt." id: description: Alert id; the opaque key consumers address the alert by — acknowledgeAlert on this rail — and correlate to the alert.{raised,cleared,acknowledged} facts. format: uuid type: string message: description: Operator-facing alert message; omitted when the stored message is empty. type: string raisedAt: description: Alert raise instant. format: date-time type: string type: description: Alert type. enum: - WINDOW_CLOSING - RECALCULATION - RELAY_DOWN - CERTIFICATE_EXPIRY - CONNECTION_DOWN - SCHEDULE_CHANGE - CAMARA_INTERRUPTED - CAMARA_CLOSED - COLLATERAL_REQUIRED - COLLATERAL_SUBSTITUTION - ELIGIBLE_ASSETS_CHANGED - INBOUND_QUARANTINED - INBOUND_SEMANTIC_REJECTED - OUTBOUND_DISPATCHER_DOWN - UNANSWERED_REQUEST - OT_REPLAY_DOWN - XSD_VALIDATOR_DOWN - MULTILATERAL_RESULT_UNREADABLE - OT_CYCLE_NOT_SETTLED type: string required: - id - type - raisedAt - active type: object ApproveCloseInputBody: additionalProperties: false properties: numCtrl: description: The control number the second operator read in the answer; must equal the request's when it carries one. type: string settledAt: description: The settlement instant the second operator confirmed; must equal the request's when it carries typed values. format: date-time type: string situation: description: The situation the second operator read in the answer; must equal the request's when it carries one. type: string type: object AuditRecordListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of audit records (never null; empty when nothing matches). items: $ref: "#/components/schemas/AuditRecordResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the trail is exhausted. type: string required: - items - hasMore type: object AuditRecordResponse: additionalProperties: false properties: actionType: description: Canonical action constant (e.g. OT_CYCLE_SETTLED). examples: - OT_CYCLE_SETTLED type: string actorId: description: Principal or service that performed the action. type: string correlationId: description: Request/flow correlation id. type: string createdAt: description: When the row was written (DB clock). format: date-time type: string details: description: Provenance JSONB object (source_event_id / provenance / before / after), projected verbatim; omitted when the stored column is NULL. Holds no raw payloads or PII by the write-side port contract. id: description: Audit record id (writer-supplied UUIDv7). format: uuid type: string occurredAt: description: When the action happened. format: date-time type: string participantIspb: description: Participant the action scopes to (8 digits); omitted when NULL. type: string resourceId: description: Specific resource id; omitted when the stored column is NULL. type: string resourceType: description: Affected resource kind. type: string summary: description: Human-readable one-line description. type: string required: - id - actorId - actionType - resourceType - summary - correlationId - occurredAt - createdAt type: object BalanceListResponse: additionalProperties: false properties: hasMore: description: Whether more statements exist beyond this page. type: boolean items: description: The page of statements (never null; empty when none). items: $ref: "#/components/schemas/BalanceResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the feed is exhausted. type: string required: - items - hasMore type: object BalanceResponse: additionalProperties: false properties: announcedAt: description: The câmara's OWN announced instant (DtHrPAG), verbatim. format: date-time type: string codIdentdTransf: description: Free transfer-identification field. RSTR0027 leaves both its existence and its content to be agreed between the câmara and this institution, so it is surfaced exactly as sent and interpreted by nobody here. type: string codMsg: description: Always PAG0200 — câmara informa saldos bilaterais para liquidação de movimento de Prestador de Serviços. type: string id: description: Statement id. format: uuid type: string ispbIF: description: This institution's ISPB, as the câmara addressed it. pattern: ^[0-9A-Z]{8}$ type: string movementDate: description: Movement date (DtMovto), YYYY-MM-DD. format: date type: string multilateralAmount: description: Valor Multilateral Banco — the câmara's stated net amount for this institution, verbatim. type: string numCtrlPAG: description: The câmara's own control number for this statement. type: string nuop: description: BCMSG unique operation number of the frame this row was projected from. type: string paymentLegs: description: The credited counterparties and their amounts, in the order the câmara sent them (never null; empty when the statement carried none). items: $ref: "#/components/schemas/LegResponse" type: array receiptLegs: description: The debited counterparties and their amounts, in the order the câmara sent them (never null; empty when the statement carried none). items: $ref: "#/components/schemas/LegResponse" type: array receivedAt: description: When this rail stored the statement. format: date-time type: string side: description: Tipo Débito ou Crédito — which side the multilateral amount falls on, as sent. type: string totalPaid: description: Valor Total Pagamento Banco, exactly as the câmara stated it. NOT derived from paymentLegs. type: string totalReceived: description: Valor Total Recebimento Banco, exactly as the câmara stated it. NOT derived from receiptLegs. type: string required: - id - codMsg - numCtrlPAG - ispbIF - codIdentdTransf - multilateralAmount - side - totalPaid - totalReceived - paymentLegs - receiptLegs - announcedAt - movementDate - nuop - receivedAt type: object BilateralLine: additionalProperties: false properties: amount: description: VlrBilatConsldd, the wire string with its decimal comma. type: string debitCredit: description: "TpDeb_CredBilatConsldd as sent: C or D." type: string ispb: description: ISPBIFBilatConsldd, the counterparty. type: string required: - ispb - debitCredit - amount type: object BusinessDayCalendarResponse: additionalProperties: false properties: holidays: description: The year's national holidays, ascending by date (never null). items: $ref: "#/components/schemas/HolidayResponse" type: array provenance: $ref: "#/components/schemas/CalendarProvenanceResponse" description: The verified BCB-artifact provenance. year: description: The calendar year served. format: int64 type: integer required: - year - holidays - provenance type: object CalendarProvenanceResponse: additionalProperties: false properties: coveredYears: description: The years the calendar authoritatively covers (ascending). items: format: int64 type: integer type: array retrievedAt: description: When the artifact was retrieved. format: date-time type: string sha256: description: Canonical SHA-256 over the artifact's holiday body. type: string sourceName: description: The artifact's declared source (BCB national bank holidays). type: string sourceUrl: description: The source URL the artifact was retrieved from. type: string required: - sourceName - sourceUrl - retrievedAt - sha256 - coveredYears type: object CamaraSessionNoticeResponse: additionalProperties: false properties: codMsg: description: The message code the câmara sent (LDL0028 abertura, LDL0029 fechamento, LDL0030 interrupção, LDL0031 retomada). type: string codProdt: description: Product code; omitted when the câmara sent none (the element is [0..1]). type: string id: description: Notice id. format: uuid type: string ispbLDL: description: The announcing câmara's ISPB, as the wire carried it. type: string movementDate: description: Movement date (DtMovto), YYYY-MM-DD. type: string noticedAt: description: The câmara's OWN announced instant (DtHrLDL), verbatim — not the moment the frame arrived. format: date-time type: string nuop: description: BCMSG unique operation number of the frame this row was projected from. type: string receivedAt: description: When this rail stored the notice. format: date-time type: string required: - id - codMsg - ispbLDL - noticedAt - movementDate - nuop - receivedAt type: object CamaraSessionResponse: additionalProperties: false properties: closed: $ref: "#/components/schemas/CamaraSessionNoticeResponse" description: Newest LDL0029 (fechamento); omitted when none was ever received. interrupted: $ref: "#/components/schemas/CamaraSessionNoticeResponse" description: Newest LDL0030 (interrupção das atividades); omitted when none was ever received. opened: $ref: "#/components/schemas/CamaraSessionNoticeResponse" description: Newest LDL0028 (abertura); omitted when none was ever received. resumed: $ref: "#/components/schemas/CamaraSessionNoticeResponse" description: Newest LDL0031 (retomada de atividades); omitted when none was ever received. type: object CapabilityListResponse: additionalProperties: false properties: correlationId: description: A fresh UUIDv7 minted for this response; it does not echo X-Request-ID. type: string items: description: The page of capabilities (never null). items: $ref: "#/components/schemas/CapabilityResponse" type: array limit: description: Effective page size. format: int64 type: integer nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string prevCursor: description: Reserved for future bidirectional cursoring; omitted until supported. type: string required: - items - limit - correlationId type: object CapabilityResponse: additionalProperties: false properties: direction: description: Message direction relative to the rail. enum: - INBOUND - OUTBOUND type: string disposition: description: Coverage disposition (full / notice / deferred / relayed). examples: - full type: string implemented: description: Whether the rail implements this message/flow (vs merely defined by SILOC). type: boolean messageType: description: The SILOC message/flow code. examples: - LDL0021 type: string required: - messageType - implemented type: object CardAnswerResponse: additionalProperties: false properties: dtHrLTR: description: The câmara's clock on an acknowledgement leg, verbatim. Absent on a position answer. type: string dtHrSit: description: "SLC0004R1 only: the câmara's clock on the situation, verbatim." type: string dtLiquid: description: "SLC0004R1 only: Data Liquidação, verbatim (YYYY-MM-DD)." type: string dtMovto: description: Data Movimento the câmara answered with, verbatim (YYYY-MM-DD). type: string numCtrlSLC: description: "SLC0004R1 only: the câmara's control number for the anticipation, verbatim." type: string positions: description: The entries an LTR0009R1 returned, verbatim; never null. Populated only for LTR0009R1, where an empty array means the câmara matched nothing. Always empty on LTR0002R1 and LTR0008R1, whose layouts carry no position group. items: $ref: "#/components/schemas/CardPositionResponse" type: array sitLancSLC: description: "SLC0004R1 only: Situação Lançamento SLC, the raw numeric code; the catalogue publishes no value for it." type: string required: - dtMovto - positions type: object CardCommandResponse: additionalProperties: false properties: acceptedAt: description: When the message reached the send leg. format: date-time type: string answer: $ref: "#/components/schemas/CardAnswerResponse" description: The câmara's answer body, verbatim. Absent until the R1 arrives. commandId: description: Lerian SLC's own command id, which is also the CloudEvents ce-id the command arrived under. format: uuid type: string messageType: description: Which card message was asked for. enum: - LTR0002 - LTR0008 - LTR0009 - SLC0004 type: string numCtrlIF: description: The control number this rail minted for the command. type: string numCtrlLTR: description: The câmara's own control number on the result being decided; absent on a position query. type: string outboundMessageId: description: The message this command produced; omitted until it has one. format: uuid type: string payload: description: The business tuple Lerian SLC sent, projected verbatim. receivedAt: description: When the command arrived. format: date-time type: string refusalReason: description: The câmara's own error codes on a refusal, or this rail's diagnosis on a failure. Never interpreted here. type: string status: description: Lifecycle state. REFUSED means the câmara rejected the decision; FAILED means it never reached the wire. enum: - RECEIVED - ACCEPTED - ANSWERED - REFUSED - FAILED type: string terminalAt: description: When the command ended. format: date-time type: string required: - commandId - messageType - payload - status - receivedAt type: object CardMessageResponse: additionalProperties: false properties: answer: $ref: "#/components/schemas/CardAnswerResponse" description: "The câmara's answer body, verbatim. Omitted until the message is ANSWERED, and on an ANSWERED message whose body this rail does not hold — which answerAbsent then states. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold (answered before bodies were stored). The câmara did answer; what it wrote is not here. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Message id. format: uuid type: string lastError: description: Why the last queue put failed, that the message waits unsent for its LBTR cycle to open at 06h40 Brasília, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when none applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: description: The submitted request, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the message and said no; FAILED means it never reached the wire. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the message was recorded. format: date-time type: string required: - id - numCtrlIF - nuop - request - status - attempts - submittedAt type: object CardPositionResponse: additionalProperties: false properties: cnpjNLiqdant: description: CNPJ of the non-settling member. type: string dtHrSit: description: The câmara's clock on the situation. type: string hist: description: Histórico, verbatim. type: string identdPartCamr: description: Câmara participant identifier. type: string ispbIFLiqdant: description: The COUNTERPARTY's settlement bank (rule RLTR0003), not this institution's. type: string numCtrlLTROr: description: The câmara's control number on the result. type: string numOpLTR: description: Gross-operation number. type: string sitLancLTR: description: Situação Lançamento LTR, verbatim; enumerated nowhere in the catalogue. type: string tpDebCred: description: Débito or crédito, verbatim; the official type enumerates nothing. type: string vlrCredNLiqdant: description: Valor Crédito Não Liquidante, verbatim. type: string vlrDebNLiqdant: description: Valor Débito Não Liquidante, verbatim. type: string vlrLanc: description: Valor Lançamento, exactly as the câmara sent it. type: string required: - numCtrlLTROr - cnpjNLiqdant - vlrLanc - tpDebCred - ispbIFLiqdant - sitLancLTR - dtHrSit type: object CertificateListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of certificates (never null). items: $ref: "#/components/schemas/CertificateResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object CertificateResponse: additionalProperties: false properties: authorityCode: description: "BACEN certificate-authority code (C10/C12 on the SFN wire): 1 SPB-Serpro, 2 SPB-Certisign, 3 Pessoas Fisicas, 4 SPB-Serasa, 5 SPB-CAIXA, 6 SPB-Valid, 7 SPB-Soluti. Derived from the certificate's own ISSUER block (OU=CSPB-N), never supplied. sfnCertificateId is unique only WITHIN this authority, so the two together are the identity." format: int64 type: integer custodyReference: description: Opaque reference to the private key in the FI's custody; the key itself is never stored here. type: string daysToExpiry: description: Whole days until expiry (0 the day it lapses, negative once expired). Always present — a real 0 is the most urgent operator signal. format: int64 type: integer id: description: Certificate id. format: uuid type: string notAfter: description: Validity end (expiry). format: date-time type: string notBefore: description: Validity start. format: date-time type: string revokedAt: description: Revocation time. Omitted while the certificate is active. format: date-time type: string serialNumber: description: Certificate serial number. type: string sfnCertificateId: description: "Exact 64-hex C11 identity used on the SFN wire: the hex encoding of the 32-byte slot, whose content is the certificate serial in uppercase ASCII hex, right-aligned and zero-left-padded. No ISPB. Unique only within authorityCode." type: string subject: description: Certificate subject DN. examples: - CN=46026562, OU=SILOC type: string required: - id - subject - notAfter - daysToExpiry - authorityCode - sfnCertificateId type: object CloseRequestInputBody: additionalProperties: false properties: numCtrl: description: The câmara's control number the operator read in the refused R1 (NumCtrlPAG, 1 to 20 characters); required for SETTLED of a PAG transfer, refused otherwise. type: string outcome: description: "What that answer states: FAILED for the message's E twin, SETTLED for the R1 of an LTR0002, LTR0008 or a PAG transfer. Required with parkedAnswerId, refused without it." enum: - SETTLED - FAILED type: string parkedAnswerId: description: The id of the refused (SEMANTIC_REJECTED) câmara answer parked for this message, which the operator read; required when such an answer blocks the close. format: uuid type: string reason: description: "The evidence that the câmara will not answer: what was checked and with whom." maxLength: 500 minLength: 1 type: string settledAt: description: The settlement instant the operator confirmed, in the past; required for SETTLED, refused otherwise. format: date-time type: string situation: description: The situation (SitLancPAG, up to 3 characters) the operator read in the refused R1; required for SETTLED of a PAG transfer, refused otherwise. type: string required: - reason type: object CycleListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of cycles (never null). items: $ref: "#/components/schemas/CycleResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object CycleResponse: additionalProperties: false properties: closedAt: description: Deposit-period close instant (PAG0103.DtHrFcht); present while the cycle still awaits its money too. format: date-time type: string createdAt: description: Row creation instant (list cursor key). format: date-time type: string id: description: Cycle id. format: uuid type: string movementDate: description: Business (reference) date, YYYY-MM-DD. type: string netPosition: $ref: "#/components/schemas/NetPosition" description: The FI's net position, from the single correlated instruction; omitted for a pre-intake OPEN cycle. openedAt: description: PAG0102 open instant (DtHrAbert). format: date-time type: string periodCode: description: Operating-period token (e.g. 01, 02). type: string product: description: Rail product; always OT. type: string settledAt: description: Settlement instant; omitted until settled. format: date-time type: string status: description: Cycle lifecycle. enum: - OPEN - SETTLING - RECALCULATING - CLOSED type: string required: - id - product - movementDate - periodCode - status - openedAt - createdAt type: object DeferredExceptionListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of parked deferred messages (never null). items: $ref: "#/components/schemas/DeferredExceptionResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object DeferredExceptionResponse: additionalProperties: false properties: codMsg: description: Declared SILOC/SFN message code; omitted when the stored column is empty. examples: - LDL0001 type: string createdAt: description: When the message was parked. format: date-time type: string id: description: Parked-message id; the handle the INBOUND_SEMANTIC_REJECTED alarm names in its details. format: uuid type: string reason: description: Which deferral parked the message; the two are drained by different replay loops. enum: - OT_DEFERRED - STATUS_DEFERRED examples: - OT_DEFERRED type: string rejectReason: description: Structured reason a SEMANTIC_REJECTED message was refused; omitted on every non-rejected row. examples: - IDENTITY_MISMATCH type: string status: description: "Lifecycle position of the parked message. SEMANTIC_REJECTED is terminal: the rail refused it on content and will never replay it." enum: - PENDING - PROCESSING - RESOLVED - SEMANTIC_REJECTED examples: - SEMANTIC_REJECTED type: string required: - id - status - reason - createdAt 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 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 FundingAckResponse: additionalProperties: false properties: at: description: The instant the verdict states (the STR situation instant for a deposit). format: date-time type: string factType: description: Funding verdict; a DEPOSIT_FAILED on an open debit means its deposit can be sent again. enum: - DEPOSIT_CONFIRMED - DEPOSIT_FAILED - CREDIT_RECEIVED - ZERO_OBLIGATION - EXCLUDED type: string refusal: $ref: "#/components/schemas/FundingRefusalResponse" description: What ended the LDL0022 with no STR launch on a DEPOSIT_FAILED (an LDL0022E, a GEN0004 naming it, or Lerian SPB's close of it); omitted on a launch. sitLancLdl: description: SitLancLDL verbatim; omitted for a verdict with no STR launch situation. type: string required: - factType - at type: object FundingRefusalResponse: additionalProperties: false properties: errorCode: description: CodErro or ErroGEN, verbatim; omitted when the E-return carried none. type: string messageCode: description: "The refusal of the STR: the LDL0022 returned with its E code, or a GEN0004 naming it; omitted when Lerian SPB closed it." enum: - LDL0022E - GEN0004 type: string railClose: description: "Why Lerian SPB closed the LDL0022 with no answer of the STR: its grade closed or its movement day ended before any send reached the MQ, or two operators closed it past its deadline; omitted on a refusal of the STR." enum: - GRADE_CLOSED - DAY_ENDED - OPERATORS_CLOSED type: string type: object GridListResponse: additionalProperties: false properties: hasMore: description: Whether a further page exists. type: boolean items: description: The grids on this page, newest reference date first (never null; empty when none match). items: $ref: "#/components/schemas/GridResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object GridResponse: additionalProperties: false properties: announcedAt: description: DtHrLDL, when the câmara announced it, on its own clock, verbatim. format: date-time type: string closesAt: description: Data Hora Fechamento, the câmara's clock, verbatim. format: date-time type: string codGrdLDL: description: Código Grade LDL, the câmara's own 5-character grid code. It is NOT a canonical window sequence and nothing here resolves it to one. type: string codProdt: description: The SILOC product. Optional on both messages, so omitted when the wire did not send it. type: string id: description: Stored grid id. format: uuid type: string ispbIF: description: This institution's ISPB. Carried by LDL0023R1 alone, so omitted on an LDL0024 row rather than fabricated. type: string ispbLDL: description: The câmara's ISPB. Carried by LDL0024 alone, so omitted on an LDL0023R1 row rather than fabricated. type: string numCtrl: description: The control number of the delivering message — the câmara's own (NumCtrlLDL) on LDL0024, this institution's own echoed back (NumCtrlIF) on LDL0023R1. type: string nuop: description: The BCMSG operation number of the frame this row was projected from, so a stored grid traces back to the delivered message. type: string opensAt: description: Data Hora Abertura, the câmara's clock, verbatim. format: date-time type: string receivedAt: description: When this rail stored the row. format: date-time type: string referenceDate: description: DtRef, the date the grid applies to. An eventual grid applies to this date alone. format: date type: string scheduleType: description: Tipo Horário, verbatim. Documented values are P (padrão) and E (eventual); the official type enumerates nothing, so a third value is shown rather than refused. type: string source: description: "The message that delivered this grid: LDL0024 is the câmara's unsolicited advice, LDL0023R1 the answer to a query this institution issued." enum: - LDL0024 - LDL0023R1 type: string required: - id - source - numCtrl - codGrdLDL - opensAt - closesAt - scheduleType - referenceDate - announcedAt - nuop - receivedAt type: object HolidayResponse: additionalProperties: false properties: date: description: National holiday date (YYYY-MM-DD). format: date type: string name: description: Holiday name, verbatim from the artifact. type: string required: - date - name type: object HomologationRunListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of runs, newest first (never null; empty when the scenario has never run). items: $ref: "#/components/schemas/HomologationRunResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the history is exhausted. type: string required: - items - hasMore type: object HomologationRunResponse: additionalProperties: false properties: evidenceRef: description: The captured run evidence, a JSON document naming the criterion, the verdict, the reason, and the facts observed. Omitted while a run is still in progress. type: string finishedAt: description: When the outcome was recorded; omitted while a run is still in progress. format: date-time type: string id: description: Run id. format: uuid type: string scenarioId: description: The scenario this run certifies. format: uuid type: string startedAt: description: When the run was claimed. format: date-time type: string status: description: Run outcome. enum: - NOT_STARTED - IN_PROGRESS - PASSED - FAILED type: string required: - id - scenarioId - status - startedAt type: object HomologationScenarioListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of scenarios (never null; empty when nothing matches). items: $ref: "#/components/schemas/HomologationScenarioResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the catalogue is exhausted. type: string required: - items - hasMore type: object HomologationScenarioResponse: additionalProperties: false properties: expectedInput: description: What the operator (or Núclea) must supply for the scenario to be exercisable. type: string id: description: Scenario id. format: uuid type: string lastRunAt: description: When the scenario was last run; omitted when it has never run. format: date-time type: string name: description: Operator-facing scenario name. type: string objective: description: What the scenario certifies. type: string passCriterion: description: What must be true of the rail for the scenario to pass. type: string status: description: Status of the scenario's latest run. enum: - NOT_STARTED - IN_PROGRESS - PASSED - FAILED type: string required: - id - name - status type: object LDL0003Payload: additionalProperties: false properties: DtHrIF: description: "Data Hora IF (xs:dateTime, [1..1]): when this institution decided, written as YYYY-MM-DDTHH:MM:SS exactly as the wire carries it." type: string DtLiquid: description: Data Liquidação (xs:date, [1..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Grupo_LDL0003_ResultLiqd: description: "Grupo Resultado Líquido ([0..n]): one repetition per non-settling member whose result this institution is confirming or diverging from. Absent when the message confirms only this institution's own result." items: $ref: "#/components/schemas/LDL0003ResultEntry" type: - array - "null" NumCtrlLDLOr: description: "Número Controle LDL Original (ControleIF, [1..1]): the câmara's control number on the LDL0001 this confirms. It is the operator's to supply because the câmara sent it; this rail neither derives it nor answers an LDL0001 on its own." type: string TpDeb_Cred: description: "Tipo Débito ou Crédito (TpDebCred, [1..1]): C (Crédito) or D (Débito)." type: string VlrLanc: description: "Valor Lançamento (Valor, [1..1]): the value this institution accepts for its OWN result. Zero states that the lançamento is not accepted." type: string required: - NumCtrlLDLOr - DtLiquid - VlrLanc - TpDeb_Cred - DtHrIF - DtMovto type: object LDL0003ResultEntry: additionalProperties: false properties: CNPJNLiqdant: description: "CNPJ Não Liquidante (CNPJ, [1..1]): the non-settling member this repetition is about." type: string IdentdPartCamr: description: Identificador Participante Câmara (IdentdPartCamr, [0..1]). type: string TpConf_Divg: description: "Tipo Confirma ou Diverge (TpConfDivg, [1..1]): C (Confirma) or D (Diverge)." type: string VlrResultLiqdNLiqdant: description: Valor Resultado Líquido Não Liquidante (Valor, [1..1]). A lançamento this institution does not accept is reported here as zero. type: string required: - CNPJNLiqdant - VlrResultLiqdNLiqdant - TpConf_Divg type: object LDL0026Payload: additionalProperties: false properties: DtLiquid: description: "Data Liquidação (xs:date, [1..1]): the settlement date being asked about." type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string required: - DtLiquid - DtMovto type: object LDL0032Payload: additionalProperties: false properties: DtMovto: description: Data Movimento (xs:date, [1..1]). type: string TpDev: description: "Tipo Devolução (TpDev, [1..1]): TOT (everything the participant may withdraw), LIM (at most VlrLimDev) or VAL (exactly VlrLimDev). LIM and VAL require VlrLimDev." type: string VlrLimDev: description: "Valor Limite Devolução (Valor, [0..1]): the amount LIM bounds and VAL names exactly. Normally omitted for TOT, where the câmara determines the total; if sent, it is written to the wire as given." type: string required: - TpDev - DtMovto type: object LDL1002AssetGroup: additionalProperties: false properties: CodProdt: description: "Código Produto (CodProdt, [0..1]). A field INSIDE the asset group, not the message-level product: this layout registers none." type: string CodSubTitlar: description: Código Subtitular (CodSubTitlar, [0..1]). type: string CodTitlar: description: "Código Titular (CodTitlar, [1..1]). RLDL0007: collateral allocated to an Entidade Responsável 2 is named HERE and in CodSubTitlar." type: string DtVenc: description: Data Vencimento (Data, [0..1]), as YYYY-MM-DD. type: string FinlddCob: description: Finalidade Cobertura (FinlddCob, [1..1]). type: string Grupo_LDL1002_CTP: $ref: "#/components/schemas/LDL1002CETIPGroup" description: "Grupo CETIP ([0..1]): present when the asset is custodied at the CETIP." Grupo_LDL1002_Fianc: $ref: "#/components/schemas/LDL1002GuaranteeGroup" description: "Grupo Fiança ([0..1]): present when the collateral is a bank guarantee." Grupo_LDL1002_ME: $ref: "#/components/schemas/LDL1002ForeignCurrencyGroup" description: "Grupo Moeda_Estrangeira ([0..1]): present when the collateral is foreign currency." Grupo_LDL1002_Otr: $ref: "#/components/schemas/LDL1002OtherGroup" description: "Grupo Outros ([0..1]): present when the collateral is none of the four named custodies." Grupo_LDL1002_SEL: $ref: "#/components/schemas/LDL1002SelicGroup" description: "Grupo Selic ([0..1]): present when the asset is custodied at the Selic." NumCtrlReqIF: description: "Número Controle Requisição IF (ControleIF, [1..1]): this asset's own control number, echoed per asset in the R1." type: string TpSubTitlar: description: Tipo Subtitular (TpTitlar, [0..1]). type: string TpTitlar: description: Tipo Titular (TpTitlar, [1..1]). type: string required: - TpTitlar - CodTitlar - FinlddCob - NumCtrlReqIF type: object LDL1002CETIPGroup: additionalProperties: false properties: CodIndxCTP: description: Código Indexador CETIP (CodIndexCETIP, [0..1]). type: string CritCalcJuros: description: Critério Cálculo Juros (CritCalcJuros, [0..1]). type: string DtEmsCTP: description: Data Emissão CETIP (Data, [1..1]), as YYYY-MM-DD. type: string EmissorActtCTP: description: Emissor Aceitante CETIP (EmissorAcCETIP, [1..1]). type: string ExprTaxJuros: description: Expressão Taxa Juros (ExprTaxJuros, [0..1]). type: string FIRCTP: description: FIR CETIP (FIRCETIP, [0..1]). A decimal STRING with at most six decimal places. type: string IdentdSistCTP: description: Identificador Sistema CETIP (IdentdSistCETIP, [1..1]). type: string IdentdTitCTP: description: Identificador Título CETIP (IdentdTitCETIP, [1..1]). type: string ParmFlutJuros: description: Parâmetro Flutuação Juros (ParmFlutJurosCTP, [0..1]). type: string PercParmJurosCTP: description: Percentual Parâmetro Juros CETIP (PercJuros, [0..1]). type: string QtdCTP: description: Quantidade CETIP (QtdCTP, [1..1]). A decimal STRING of up to 22 digits; never a float. type: string SubTpAtv: description: SubTipo Ativo (SubTpAtv, [1..1]). type: string TaxCTP: description: Taxa CETIP (TaxCETIP, [0..1]). A decimal STRING with at most four decimal places. type: string VlrFinanc: description: Valor Financeiro (Valor, [0..1]). A decimal STRING with at most two decimal places. type: string required: - SubTpAtv - IdentdTitCTP - IdentdSistCTP - EmissorActtCTP - QtdCTP - DtEmsCTP type: object LDL1002ForeignCurrencyGroup: additionalProperties: false properties: CodMoeda: description: Código Moeda (CodMoeda, [1..1]). type: string VlrME: description: Valor Moeda_Estrangeira (Valor, [1..1]). A decimal STRING with at most two decimal places. type: string required: - CodMoeda - VlrME type: object LDL1002GuaranteeGroup: additionalProperties: false properties: CNPJEmissorFianc: description: CNPJ Emissor Fiança (CNPJ, [1..1]). type: string DtEmsFianc: description: Data Emissão Fiança (Data, [1..1]), as YYYY-MM-DD. type: string NumCtrlEmissorFianc: description: Número Controle Emissor Fiança (NumCtrlEmisFian, [0..1]). type: string VlrFaceFianc: description: Valor Face Fiança (Valor, [1..1]). A decimal STRING with at most two decimal places. type: string required: - CNPJEmissorFianc - DtEmsFianc - VlrFaceFianc type: object LDL1002OtherGroup: additionalProperties: false properties: ISPBIFLiqdant: description: ISPB IF Liquidante (ISPB, [0..1]). type: string IdentdOtrAtv: description: Identificador Outros Ativos (IdentdOtrAtv, [1..1]). type: string Qtd: description: Quantidade (Qtd, [0..1]). type: string TpOtrAtv: description: Tipo Outros Ativos (TpOtrAtv, [1..1]). type: string Vlr: description: Valor (Valor, [0..1]). A decimal STRING with at most two decimal places. type: string required: - TpOtrAtv - IdentdOtrAtv type: object LDL1002Payload: additionalProperties: false properties: CNPJEntRespons: description: CNPJ Entidade Responsável (CNPJ, [1..1]). The responsible entity this institution acts for. type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string Grupo_LDL1002_Atv: description: "Grupo Ativo ([1..n]): one entry per asset. An empty list is refused — a request naming no asset would look, to the operator who sent it, like an acceptance in flight." items: $ref: "#/components/schemas/LDL1002AssetGroup" type: - array - "null" ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1])." type: string NumCtrlLDLOr: description: "Número Controle LDL Original (ControleIF, [0..1]): the câmara demand this acceptance answers." type: string TpAtv: description: Tipo Ativo (TpAtv, [1..1]). type: string TpReq: description: "Tipo Requisição (TpReq, [1..1]): whether the deposit is voluntary or required." type: string required: - ISPBLDL - CNPJEntRespons - TpAtv - TpReq - Grupo_LDL1002_Atv - DtMovto type: object LDL1002SelicGroup: additionalProperties: false properties: IdentdTitSEL: description: Identificador Título Selic (IdentdTitSEL, [1..1]). type: string QtdTit: description: Quantidade Título (QtdTit, [1..1]). type: string required: - IdentdTitSEL - QtdTit type: object LDL1003AssetGroup: additionalProperties: false properties: Grupo_LDL1003_CTP: $ref: "#/components/schemas/LDL1003CETIPGroup" description: "Grupo CETIP ([0..1]): present when the deposit is effected by a CETIP transfer." Grupo_LDL1003_SEL: $ref: "#/components/schemas/LDL1003SelicGroup" description: "Grupo Selic ([0..1]): present when the deposit is effected by a Selic transfer." NumCtrlActeLDLOr: description: "Número Controle Aceite LDL Original (ControleIF, [1..1]): the NumCtrlActeLDL the câmara returned when it accepted this asset." type: string NumCtrlReqIFOr: description: "Número Controle Requisição IF Original (ControleIF, [1..1]): the NumCtrlReqIF this institution sent on the LDL1002 asset being deposited." type: string required: - NumCtrlReqIFOr - NumCtrlActeLDLOr type: object LDL1003CETIPGroup: additionalProperties: false properties: DtAquis: description: Data Aquisição (Data, [0..1]), as YYYY-MM-DD. type: string IdentdCtrapartCamr: description: Identificador Contraparte Câmara (IdentdPartCamr, [1..1]). type: string IdentdPartCamr: description: Identificador Participante Câmara (IdentdPartCamr, [1..1]). type: string NumOpCTP: description: "Número Operação CTP (NumOpCETIP, [1..1]). RLDL0008: one CETIP transfer feeding several allocations repeats its number on each of them." type: string PUAquis: description: Preço_Unitário Aquisição (PU, [0..1]). A decimal STRING with at most eight decimal places. type: string required: - NumOpCTP - IdentdPartCamr - IdentdCtrapartCamr type: object LDL1003Payload: additionalProperties: false properties: CNPJEntRespons: description: CNPJ Entidade Responsável (CNPJ, [1..1]). The responsible entity this institution acts for. type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string Grupo_LDL1003_Atv: description: "Grupo Ativo ([1..n]): one entry per asset being deposited. An empty list is refused — a request naming no asset would look, to the operator who sent it, like a deposit in flight." items: $ref: "#/components/schemas/LDL1003AssetGroup" type: - array - "null" ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1])." type: string TpAtv: description: Tipo Ativo (TpAtv, [1..1]). type: string TpReq: description: "Tipo Requisição (TpReq, [1..1]): whether the deposit is voluntary or required." type: string required: - ISPBLDL - CNPJEntRespons - TpAtv - TpReq - Grupo_LDL1003_Atv - DtMovto type: object LDL1003SelicGroup: additionalProperties: false properties: ChASEL: description: Chave Associação Selic (OpSEL, [0..1]). type: string CtCed: description: "Conta Cedente (CtSEL, [1..1]): the Selic account the security leaves." type: string CtCes: description: "Conta Cessionária (CtSEL, [1..1]): the Selic account the security reaches." type: string NumOpSEL: description: "Número Operação Selic (OpSEL, [0..1]). RLDL0008: one Selic transfer feeding several allocations repeats its number on each of them." type: string PU: description: Preço_Unitário (PU, [0..1]). A decimal STRING with at most eight decimal places. type: string required: - CtCed - CtCes type: object LDL1006AssetGroup: additionalProperties: false properties: CodProdt: description: "Código Produto (CodProdt, [0..1]). A field INSIDE the asset group, not the message-level product: this layout registers none." type: string CodSubTitlar: description: Código Subtitular (CodSubTitlar, [0..1]). type: string CodTitlar: description: Código Titular (CodTitlar, [1..1]). type: string DtVenc: description: Data Vencimento (Data, [0..1]), as YYYY-MM-DD. type: string FinlddCob: description: Finalidade Cobertura (FinlddCob, [1..1]). type: string Grupo_LDL1006_CTP: $ref: "#/components/schemas/LDL1006CETIPGroup" description: "Grupo CETIP ([0..1]): present when the asset is custodied at the CETIP." Grupo_LDL1006_Fianc: $ref: "#/components/schemas/LDL1006GuaranteeGroup" description: "Grupo Fiança ([0..1]): present when the collateral is a bank guarantee." Grupo_LDL1006_ME: $ref: "#/components/schemas/LDL1006ForeignCurrencyGroup" description: "Grupo Moeda_Estrangeira ([0..1]): present when the collateral is foreign currency." Grupo_LDL1006_Otr: $ref: "#/components/schemas/LDL1006OtherGroup" description: "Grupo Outros ([0..1]): present when the collateral is none of the four named custodies." Grupo_LDL1006_SEL: $ref: "#/components/schemas/LDL1006SelicGroup" description: "Grupo Selic ([0..1]): present when the asset is custodied at the Selic." NumAtv: description: "Número Ativo (NumAtv, [0..1]): the câmara's own number for the deposited asset, when the requester knows it." type: string NumCtrlReqIF: description: "Número Controle Requisição IF (ControleIF, [1..1]): this asset's own control number, echoed per asset in the R1 with its own accept-or-refuse verdict." type: string TpSubTitlar: description: Tipo Subtitular (TpTitlar, [0..1]). type: string TpTitlar: description: Tipo Titular (TpTitlar, [1..1]). type: string required: - TpTitlar - CodTitlar - FinlddCob - NumCtrlReqIF type: object LDL1006CETIPGroup: additionalProperties: false properties: DtAquis: description: Data Aquisição (Data, [0..1]), as YYYY-MM-DD. type: string DtEmsCTP: description: Data Emissão CETIP (Data, [1..1]), as YYYY-MM-DD. type: string EmissorActtCTP: description: Emissor Aceitante CETIP (EmissorAcCETIP, [1..1]). type: string FIRCTP: description: FIR CETIP (FIRCETIP, [1..1]). REQUIRED here, unlike on LDL1002 where the same tag is [0..1]. A decimal STRING with at most six decimal places. type: string IdentdCtrapartCamr: description: Identificador Contraparte Câmara (IdentdPartCamr, [1..1]). type: string IdentdPartCamr: description: Identificador Participante Câmara (IdentdPartCamr, [1..1]). type: string IdentdSistCTP: description: Identificador Sistema CETIP (IdentdSistCETIP, [1..1]). type: string IdentdTitCTP: description: Identificador Título CETIP (IdentdTitCETIP, [1..1]). type: string NumOpCTP: description: Número Operação CTP (NumOpCETIP, [1..1]). type: string PUAquis: description: Preço_Unitário Aquisição (PU, [0..1]). A decimal STRING with at most eight decimal places. type: string QtdCTP: description: Quantidade CETIP (QtdCTP, [1..1]). A decimal STRING of up to 22 digits; never a float. type: string QtdMinTitCTP: description: "Quantidade Mínima Título CETIP (Qtd, [1..1]): the least the requester accepts, below which the câmara is to refuse rather than partially release." type: string SubTpAtv: description: SubTipo Ativo (SubTpAtv, [1..1]). type: string TaxCTP: description: Taxa CETIP (TaxCETIP, [0..1]). A decimal STRING with at most four decimal places. type: string required: - SubTpAtv - NumOpCTP - IdentdPartCamr - IdentdCtrapartCamr - IdentdTitCTP - IdentdSistCTP - EmissorActtCTP - FIRCTP - QtdCTP - QtdMinTitCTP - DtEmsCTP type: object LDL1006ForeignCurrencyGroup: additionalProperties: false properties: CodMoeda: description: Código Moeda (CodMoeda, [1..1]). type: string VlrME: description: Valor Moeda_Estrangeira (Valor, [1..1]). A decimal STRING with at most two decimal places. type: string VlrMinME: description: "Valor Mínimo Moeda_Estrangeira (Valor, [0..1]): the least the requester accepts." type: string required: - CodMoeda - VlrME type: object LDL1006GuaranteeGroup: additionalProperties: false properties: CNPJEmissorFianc: description: CNPJ Emissor Fiança (CNPJ, [1..1]). type: string DtEmsFianc: description: Data Emissão Fiança (Data, [1..1]), as YYYY-MM-DD. type: string NumCtrlEmissorFianc: description: Número Controle Emissor Fiança (NumCtrlEmisFian, [0..1]). type: string VlrFaceFianc: description: Valor Face Fiança (Valor, [1..1]). A decimal STRING with at most two decimal places. type: string required: - CNPJEmissorFianc - DtEmsFianc - VlrFaceFianc type: object LDL1006OtherGroup: additionalProperties: false properties: ISPBIFLiqdant: description: ISPB IF Liquidante (ISPB, [0..1]). type: string IdentdOtrAtv: description: Identificador Outros Ativos (IdentdOtrAtv, [1..1]). type: string Qtd: description: Quantidade (Qtd, [0..1]). type: string QtdMin: description: "Quantidade Mínima (Qtd, [0..1]): the least the requester accepts." type: string TpOtrAtv: description: Tipo Outros Ativos (TpOtrAtv, [1..1]). type: string Vlr: description: Valor (Valor, [0..1]). A decimal STRING with at most two decimal places. type: string VlrMin: description: "Valor Mínimo (Valor, [0..1]): the least the requester accepts." type: string required: - TpOtrAtv - IdentdOtrAtv type: object LDL1006Payload: additionalProperties: false properties: CNPJEntRespons: description: CNPJ Entidade Responsável (CNPJ, [1..1]). The responsible entity this institution acts for. type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string Grupo_LDL1006_Atv: description: "Grupo Ativo ([1..n]): one entry per asset. An empty list is refused — a request naming no asset would look, to the operator who sent it, like a withdrawal in flight." items: $ref: "#/components/schemas/LDL1006AssetGroup" type: - array - "null" ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1])." type: string NumCtrlLDLOr: description: "Número Controle LDL Original (ControleIF, [0..1]): the câmara demand this withdrawal answers." type: string TpAtv: description: Tipo Ativo (TpAtv, [1..1]). type: string TpReq: description: "Tipo Requisição (TpReq, [1..1]): whether the withdrawal is voluntary or required." type: string required: - ISPBLDL - CNPJEntRespons - TpAtv - TpReq - Grupo_LDL1006_Atv - DtMovto type: object LDL1006SelicGroup: additionalProperties: false properties: ChASEL: description: Chave Associação Selic (OpSEL, [0..1]). type: string CtCed: description: "Conta Cedente (CtSEL, [1..1]): the Selic account the security leaves." type: string CtCes: description: "Conta Cessionária (CtSEL, [1..1]): the Selic account the security reaches." type: string IdentdTitSEL: description: Identificador Título Selic (IdentdTitSEL, [1..1]). type: string PU: description: Preço_Unitário (PU, [0..1]). A decimal STRING with at most eight decimal places. type: string QtdMinTit: description: "Quantidade Mínima Título (Qtd, [1..1]): the least the requester accepts, below which the câmara is to refuse rather than partially release." type: string QtdTit: description: "Quantidade Título (QtdTit, [1..1]): the quantity asked for." type: string required: - IdentdTitSEL - CtCed - CtCes - QtdTit - QtdMinTit type: object LDL1010Payload: additionalProperties: false properties: CNPJEntRespons: description: CNPJ Entidade Responsável (CNPJ, [1..1]). The responsible entity this institution acts for. type: string CodSubTitlar: description: Código Subtitular (CodSubTitlar, [0..1]). type: string CodTitlar: description: Código Titular (CodTitlar, [1..1]). type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string DtNovVenc: description: "Data Novo Vencimento (Data, [0..1]): the guarantee's new maturity, as YYYY-MM-DD." type: string ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1])." type: string NumAtv: description: "Número Ativo (NumAtv, [0..1]): the câmara's own number for the guarantee being amended." type: string TpSubTitlar: description: Tipo Subtitular (TpTitlar, [0..1]). type: string TpTitlar: description: Tipo Titular (TpTitlar, [1..1]). type: string VlrAditt: description: "Valor Aditamento (Valor, [0..1]): the guarantee's new amount. A decimal STRING with at most two decimal places." type: string required: - ISPBLDL - CNPJEntRespons - TpTitlar - CodTitlar - DtMovto type: object LDL1012Payload: additionalProperties: false properties: CNPJEntRespons1_2: description: CNPJ Entidade Responsável 1 ou 2 (CNPJ, [1..1]). The responsible entity this institution acts for. type: string CodProdt: description: "Código Produto (CodProdt, [0..1]): narrows the query to one câmara product. A payload field, not the registered product." type: string CodSubTitlar: description: Código Subtitular (CodSubTitlar, [0..1]). type: string CodTitlar: description: "Código Titular (CodTitlar, [1..1]): the holder the answer is scoped to." type: string CtCstdia: description: "Conta Custódia (CtSEL, [0..1]): the Selic custody account to narrow the query to." type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string FinlddCob: description: "Finalidade Cobertura (FinlddCob, [1..1]): what the deposited collateral covers." type: string ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1])." type: string SubTpAtv: description: SubTipo Ativo (SubTpAtv, [0..1]). type: string TpAtv: description: "Tipo Ativo (TpAtv, [0..1]): narrows the query to one asset class." type: string TpRet: description: "Tipo Retorno (TpRet, [1..1]): the shape of answer the câmara returns for this query." type: string TpSubTitlar: description: Tipo Subtitular (TpTitlar, [0..1]). type: string TpTitlar: description: "Tipo Titular (TpTitlar, [1..1]): the holder the answer is scoped to." type: string required: - ISPBLDL - CNPJEntRespons1_2 - TpTitlar - CodTitlar - FinlddCob - TpRet - DtMovto type: object LDL1013Payload: additionalProperties: false properties: CNPJEntRespons1_2: description: CNPJ Entidade Responsável 1 ou 2 (CNPJ, [1..1]). The responsible entity this institution acts for. FOURTH element in this layout, ahead of ISPBLDL. type: string CodMoeda: description: "Código Moeda (CodMoeda, [0..1]): names a foreign currency as the asset queried." type: string CodProdt: description: "Código Produto (CodProdt, [0..1]): narrows the query to one câmara product. A payload field, not the registered product." type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string DtVenc: description: Data Vencimento (Data, [0..1]), as YYYY-MM-DD. RLDL0010 pairs it with IdentdTitSEL. type: string EmissorActtCTP: description: Emissor Aceitante CETIP (EmissorAcCETIP, [0..1]). RLDL0011 admits it for CETIP papers. type: string ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1]). FIFTH element in this layout, behind CNPJEntRespons1_2." type: string IdentdOtrAtv: description: Identificador Outros Ativos (IdentdOtrAtv, [0..1]). type: string IdentdTitCTP: description: Identificador Título CETIP (IdentdTitCETIP, [0..1]). type: string IdentdTitISIN: description: Identificador Título ISIN (CodISIN, [0..1]). type: string IdentdTitSEL: description: Identificador Título Selic (IdentdTitSEL, [0..1]). RLDL0010 pairs it with DtVenc to name one asset. type: string SubTpAtv: description: SubTipo Ativo (SubTpAtv, [0..1]). type: string TpAtv: description: Tipo Ativo (TpAtv, [0..1]). RLDL0009 asks for it on a search; the schema declares it optional. type: string TpRet: description: "Tipo Retorno (TpRet, [1..1]): the shape of answer the câmara returns for this query." type: string required: - CNPJEntRespons1_2 - ISPBLDL - TpRet - DtMovto type: object LDL1015CETIPGroup: additionalProperties: false properties: DtEmsCTP: description: Data Emissão CETIP (Data, [0..1]), as YYYY-MM-DD. type: string EmissorActtCTP: description: Emissor Aceitante CETIP (EmissorAcCETIP, [1..1] within the group). type: string FIRCTP: description: FIR CETIP (FIRCETIP, [0..1]). A decimal STRING with at most six decimal places. type: string IdentdSistCTP: description: Identificador Sistema CETIP (IdentdSistCETIP, [1..1] within the group). type: string IdentdTitCTP: description: Identificador Título CETIP (IdentdTitCETIP, [1..1] within the group). type: string TaxCTP: description: Taxa CETIP (TaxCETIP, [0..1]). A decimal STRING with at most four decimal places. type: string required: - IdentdTitCTP - IdentdSistCTP - EmissorActtCTP type: object LDL1015Payload: additionalProperties: false properties: CNPJEntRespons1_2: description: CNPJ Entidade Responsável 1 ou 2 (CNPJ, [1..1]). The responsible entity this institution acts for. FOURTH element in this layout, ahead of ISPBLDL. type: string DtCot: description: "Data Cotação (Data, [1..1]), as YYYY-MM-DD: the day whose prices are being asked for." type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string DtVenc: description: Data Vencimento (Data, [0..1]), as YYYY-MM-DD. RLDL0010 pairs it with IdentdTitSEL. type: string Grupo_LDL1015_CTP: $ref: "#/components/schemas/LDL1015CETIPGroup" description: "Grupo CETIP ([0..1]): the CETIP coordinates of the paper queried, supplied whole or omitted." ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1]). FIFTH element in this layout, behind CNPJEntRespons1_2." type: string IdentdTitISIN: description: Identificador Título ISIN (CodISIN, [0..1]). type: string IdentdTitSEL: description: Identificador Título Selic (IdentdTitSEL, [0..1]). type: string IndrPrzLiquid: description: "Indicador Prazo Liquidação (IndrPrazoLiquid, [1..1]): the settlement term the prices are asked for." type: string TpRet: description: "Tipo Retorno (TpRet, [1..1]): the shape of answer the câmara returns for this query." type: string required: - CNPJEntRespons1_2 - ISPBLDL - DtCot - IndrPrzLiquid - TpRet - DtMovto type: object LDL1016CETIPGroup: additionalProperties: false properties: DtEmsCTP: description: Data Emissão CETIP (Data, [1..1] within the group), as YYYY-MM-DD. type: string EmissorActtCTP: description: Emissor Aceitante CETIP (EmissorAcCETIP, [1..1] within the group). type: string FIRCTP: description: FIR CETIP (FIRCETIP, [0..1]). A decimal STRING with at most six decimal places. type: string IdentdTitCTP: description: Identificador Título CETIP (IdentdTitCETIP, [1..1] within the group). type: string QtdCTP: description: Quantidade CETIP (QtdCTP, [1..1] within the group). A decimal STRING of up to twenty-two digits. type: string TaxCTP: description: Taxa CETIP (TaxCETIP, [1..1] within the group). A decimal STRING with at most four decimal places. type: string required: - IdentdTitCTP - EmissorActtCTP - TaxCTP - QtdCTP - DtEmsCTP type: object LDL1016FiancaGroup: additionalProperties: false properties: CNPJEmissorFianc: description: CNPJ Emissor Fiança (CNPJ, [1..1] within the group). type: string DtEmsFianc: description: Data Emissão Fiança (Data, [1..1] within the group), as YYYY-MM-DD. type: string VlrFaceFianc: description: Valor Face Fiança (Valor, [1..1] within the group). A decimal STRING with at most two decimal places. type: string required: - CNPJEmissorFianc - DtEmsFianc - VlrFaceFianc type: object LDL1016MoedaEstrangeiraGroup: additionalProperties: false properties: CodMoeda: description: Código Moeda (CodMoeda, [1..1] within the group). type: string VlrME: description: Valor Moeda_Estrangeira (Valor, [1..1] within the group). A decimal STRING with at most two decimal places. type: string required: - CodMoeda - VlrME type: object LDL1016OutrosGroup: additionalProperties: false properties: IdentdOtrAtv: description: Identificador Outros Ativos (IdentdOtrAtv, [1..1] within the group). type: string Qtd: description: Quantidade (Qtd, [0..1]). type: string Vlr: description: Valor (Valor, [0..1]). A decimal STRING with at most two decimal places. type: string required: - IdentdOtrAtv type: object LDL1016Payload: additionalProperties: false properties: CNPJEntRespons1_2: description: CNPJ Entidade Responsável 1 ou 2 (CNPJ, [1..1]). The responsible entity this institution acts for. type: string CodSubTitlarDest: description: Código Subtitular Destino (CodSubTitlar, [0..1]). type: string CodSubTitlarOrigem: description: Código Subtitular Origem (CodSubTitlar, [0..1]). type: string CodTitlarDest: description: Código Titular Destino (CodTitlar, [0..1]). type: string CodTitlarOrigem: description: Código Titular Origem (CodTitlar, [0..1]). type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string DtVenc: description: Data Vencimento (Data, [0..1]), as YYYY-MM-DD. type: string FinlddCobDest: description: "Finalidade Cobertura Destino (FinlddCob, [0..1]): what the collateral covers on the leg it reaches." type: string FinlddCobOrigem: description: "Finalidade Cobertura Origem (FinlddCob, [0..1]): what the collateral covers on the leg it leaves." type: string Grupo_LDL1016_CTP: $ref: "#/components/schemas/LDL1016CETIPGroup" description: "Grupo CETIP ([0..1]): the CETIP paper being moved, its rate and its quantity." Grupo_LDL1016_Fianc: $ref: "#/components/schemas/LDL1016FiancaGroup" description: "Grupo Fiança ([0..1]): the bank guarantee being moved." Grupo_LDL1016_ME: $ref: "#/components/schemas/LDL1016MoedaEstrangeiraGroup" description: "Grupo Moeda_Estrangeira ([0..1]): the foreign currency being moved." Grupo_LDL1016_Otr: $ref: "#/components/schemas/LDL1016OutrosGroup" description: "Grupo Outros ([0..1]): an asset of no other class, named by the câmara's own identifier." Grupo_LDL1016_SEL: $ref: "#/components/schemas/LDL1016SelicGroup" description: "Grupo Selic ([0..1]): the Selic paper being moved and the accounts it moves between." ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1])." type: string NumAtv: description: "Número Ativo (NumAtv, [0..1]): the câmara's own number for the deposited asset being moved." type: string NumCtrlLDLOr: description: "Número Controle LDL Original (ControleIF, [0..1]). RLDL0012: it names the Número Controle of the LDL1001 that required this collateral." type: string TpAtv: description: "Tipo Ativo (TpAtv, [1..1]): the class of the asset being moved." type: string TpSubTitlarDest: description: Tipo Subtitular Destino (TpTitlar, [0..1]). type: string TpSubTitlarOrigem: description: Tipo Subtitular Origem (TpTitlar, [0..1]). type: string TpTitlarDest: description: Tipo Titular Destino (TpTitlar, [0..1]). type: string TpTitlarOrigem: description: Tipo Titular Origem (TpTitlar, [0..1]). type: string required: - ISPBLDL - CNPJEntRespons1_2 - TpAtv - DtMovto type: object LDL1016SelicGroup: additionalProperties: false properties: CtCed: description: "Conta Cedente (CtSEL, [0..1]): the Selic account the paper leaves." type: string CtCes: description: "Conta Cessionária (CtSEL, [0..1]): the Selic account the paper reaches." type: string IdentdTitSEL: description: Identificador Título Selic (IdentdTitSEL, [1..1] within the group). type: string QtdTit: description: Quantidade Título (QtdTit, [1..1] within the group). type: string required: - IdentdTitSEL - QtdTit type: object LDL1017Payload: additionalProperties: false properties: CNPJEntRespons: description: CNPJ Entidade Responsável (CNPJ, [1..1]). The responsible entity this institution acts for. type: string CodSubTitlar: description: Código Subtitular (CodSubTitlar, [0..1]). type: string CodTitlar: description: Código Titular (CodTitlar, [1..1]). type: string DtMovto: description: Data Movimento (Data, [1..1]), as YYYY-MM-DD. type: string ISPBLDL: description: "ISPB LDL: the câmara addressed (ISPB, [1..1])." type: string NumAtv: description: "Número Ativo (NumAtv, [1..1]): the câmara's own number for the deposited asset being moved." type: string NumCtrlLDLOr: description: "Número Controle LDL Original (ControleIF, [0..1]). RLDL0012: it names the Número Controle of the LDL1001 that required this collateral." type: string QtdAnt: description: Quantidade Anterior (Qtd, [0..1]). type: string QtdNovAtv: description: Quantidade Novo Ativo (Qtd, [0..1]). type: string TpSubTitlar: description: Tipo Subtitular (TpTitlar, [0..1]). type: string TpTitlar: description: Tipo Titular (TpTitlar, [1..1]). type: string VlrAntAtv: description: Valor Anterior Ativo (Valor, [0..1]). A decimal STRING with at most two decimal places. type: string VlrNovAtv: description: Valor Novo Ativo (Valor, [0..1]). A decimal STRING with at most two decimal places. type: string required: - ISPBLDL - CNPJEntRespons - TpTitlar - CodTitlar - NumAtv - DtMovto type: object LDL1019Payload: additionalProperties: false properties: CNPJEntRespons: description: CNPJ Entidade Responsável (CNPJ, [1..1]). type: string DtHrIF: description: "Data Hora IF (xs:dateTime, [1..1]): when this institution decided, written as YYYY-MM-DDTHH:MM:SS exactly as the wire carries it." type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string DtNovVenc: description: "Data Novo Vencimento (xs:date, [0..1]): present when the confirmation is of an aditamento that moves the maturity." type: string NumCtrlLDLOr: description: "Número Controle LDL Original (ControleIF, [1..1]): filled with the Número Controle LDL received on the LDL1018 being confirmed (RLDL0013). It is the operator's to supply because the câmara sent it." type: string SitConfc: description: "Situação Confirmação (Indr, [1..1]): S (Sim) confirms the position the câmara announced, N (Não) rejects it." type: string VlrAditt: description: "Valor Aditamento (Valor, [0..1]): present when the confirmation is of an aditamento that changes the value." type: string required: - CNPJEntRespons - NumCtrlLDLOr - SitConfc - DtHrIF - DtMovto type: object LDLCollateralAnswerResponse: additionalProperties: false properties: camaraAt: description: The câmara's own clock for the answer (DtHrLDL or DtHrSit). Omitted for LDL1002R1, LDL1003R1 and LDL1006R1, whose layouts carry an instant per asset inside the repeating group rather than one for the message — those instants are inside details. format: date-time type: string codMsg: description: The answer's own code, e.g. LDL1002R1. type: string details: description: "Everything the answer carried beyond the fields beside it, projected as a JSON object keyed by the official tag names — the situação, the per-asset groups, the amounts and quantities. Its SHAPE DIFFERS PER CODE because the nine answer legs agree on nothing below the header, and it follows one rule on every code: a leaf element is its trimmed text as a STRING (amounts included, never a number); a Grupo_* element is an ARRAY of objects at every cardinality, one asset included; any other element with children is an OBJECT. This rail decodes nothing and computes nothing from it." movementDate: description: Data Movimento. format: date type: string numCtrlLDL: description: "Número Controle LDL: the CÂMARA's own control number for what it did. A later request names it as NumCtrlLDLOr, so it is the identifier needed to amend or reverse this movement." type: string required: - codMsg - numCtrlLDL - details - movementDate type: object LDLIFCommandAnswerResponse: additionalProperties: false properties: codMsg: description: The answer's own code, e.g. LDL0026R1. type: string details: additionalProperties: {} description: "Everything the answer carries beyond the header, keyed by the Catálogo's own tag names and projected verbatim — an empty object for LDL0003R1, whose body is header only. A REPEATING GROUP IS ALWAYS AN ARRAY, even when the câmara sent one repetition; a group it sent none of is absent. Values such as TpInf and SitLancDev are carried exactly as written and never decoded: they are published in BACEN's separate Dicionário de Domínios with their own activation and deactivation dates, so what one means is the ledger consumer's call." type: object movementDate: description: Data Movimento. format: date type: string situationAt: description: The câmara's own clock — DtHrLDL on LDL0003R1 and LDL0026R1, DtHrSit on LDL0032R1 — read as a wall-clock time in the SFN's calendar zone (America/Sao_Paulo) and published as that instant. The instant is the câmara's; the rendering is this rail's. format: date-time type: string required: - codMsg - situationAt - movementDate - details type: object LdlCollateralBodyLDL1002Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1002Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlCollateralBodyLDL1003Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1003Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlCollateralBodyLDL1006Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1006Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlCollateralBodyLDL1010Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1010Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlCollateralBodyLDL1012Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1012Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlCollateralBodyLDL1013Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1013Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlCollateralBodyLDL1015Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1015Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlCollateralBodyLDL1016Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1016Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlCollateralBodyLDL1017Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLCollateralAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN request code this row carries, e.g. LDL1002. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1017Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the request was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlIFCommandBodyLDL0003Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLIFCommandAnswerResponse" description: "What the câmara answered; omitted until it has answered, and never present for LDL1019, which has no answer leg. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN command code this row carries, e.g. LDL0003. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL0003Payload" description: The request exactly as it was submitted, projected verbatim. status: description: "Lifecycle state. REFUSED means the câmara received the command and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. LDL1019 has no positive answer leg in the Catálogo, so an accepted LDL1019 stays DISPATCHED: delivered, and no reply is owed." enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the command was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlIFCommandBodyLDL0026Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLIFCommandAnswerResponse" description: "What the câmara answered; omitted until it has answered, and never present for LDL1019, which has no answer leg. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN command code this row carries, e.g. LDL0003. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL0026Payload" description: The request exactly as it was submitted, projected verbatim. status: description: "Lifecycle state. REFUSED means the câmara received the command and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. LDL1019 has no positive answer leg in the Catálogo, so an accepted LDL1019 stays DISPATCHED: delivered, and no reply is owed." enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the command was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlIFCommandBodyLDL0032Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLIFCommandAnswerResponse" description: "What the câmara answered; omitted until it has answered, and never present for LDL1019, which has no answer leg. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN command code this row carries, e.g. LDL0003. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL0032Payload" description: The request exactly as it was submitted, projected verbatim. status: description: "Lifecycle state. REFUSED means the câmara received the command and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. LDL1019 has no positive answer leg in the Catálogo, so an accepted LDL1019 stays DISPATCHED: delivered, and no reply is owed." enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the command was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LdlIFCommandBodyLDL1019Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/LDLIFCommandAnswerResponse" description: "What the câmara answered; omitted until it has answered, and never present for LDL1019, which has no answer leg. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN command code this row carries, e.g. LDL0003. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/LDL1019Payload" description: The request exactly as it was submitted, projected verbatim. status: description: "Lifecycle state. REFUSED means the câmara received the command and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. LDL1019 has no positive answer leg in the Catálogo, so an accepted LDL1019 stays DISPATCHED: delivered, and no reply is owed." enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the command was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object LegResponse: additionalProperties: false properties: amount: description: "The amount the câmara attributed to this counterparty, as the wire string it sent (never parsed into a number)." type: string ispb: description: "The counterparty institution's ISPB: credited on a payment leg, debited on a receipt leg." pattern: ^[0-9A-Z]{8}$ type: string required: - ispb - amount type: object ListCardCommandsOutputBody: additionalProperties: false properties: items: description: The commands, newest first (never null). items: $ref: "#/components/schemas/CardCommandResponse" type: array required: - items type: object MultilateralResultListResponse: additionalProperties: false properties: hasMore: description: Whether more results exist beyond this page. type: boolean items: description: The page of results (never null; empty when none). items: $ref: "#/components/schemas/MultilateralResultResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the feed is exhausted. type: string required: - items - hasMore type: object MultilateralResultResponse: additionalProperties: false properties: amount: description: VlrMultlatBco, the wire string with its decimal comma. Never summed or recomputed here. type: string counterparties: description: Grupo_BilatConsldd, the position consolidated per counterparty, in wire order. items: $ref: "#/components/schemas/BilateralLine" type: array cycle: description: "CodCiclo as sent: 1 or 2." type: string cycleAt: description: DtHrCiclo as sent, aaaammddhhmm. type: string debitCredit: description: "TpDeb_CredMultlatBco as sent: C or D, the side of this institution's multilateral net." type: string ldlAt: description: DtHrLDL as sent, the câmara's clock, aaaammddhhmm. type: string movementDate: description: DtMovto as sent, AAAAMMDD. type: string noticeId: description: The GEN0015 file notice the result arrived on (see listFileNotices). format: uuid type: string nuop: description: BCMSG unique operation number of that GEN0015. type: string products: description: Grupo_Prodt, the multilateral net per product with its bilateral legs, in wire order. items: $ref: "#/components/schemas/ProductResult" type: array receivedAt: description: When this rail stored the result. format: date-time type: string required: - noticeId - nuop - cycle - cycleAt - debitCredit - amount - counterparties - products - ldlAt - movementDate - receivedAt type: object NetPosition: additionalProperties: false properties: amount: description: Canonical net amount (NUMERIC(19,2)), decimal string. type: string side: description: Money direction of the FI's net obligation. enum: - DEBIT - CREDIT type: string required: - side - amount type: object NonLiquidanteDecisionInputBody: additionalProperties: false properties: decidedAt: description: The deciding institution's own clock (DtHrIF). format: date-time type: string movementDate: description: The movement date (DtMovto), YYYY-MM-DD. format: date type: string numCtrlLTROr: description: The câmara's control number on the LTR0007 being answered (NumCtrlLTROr). maxLength: 20 minLength: 1 type: string tpConfDivg: description: "Tipo Confirma ou Diverge: C (Confirma) or D (Diverge, a rejection), the Dicionário de Domínios TpConfDivg values." maxLength: 1 minLength: 1 type: string required: - numCtrlLTROr - tpConfDivg - decidedAt - movementDate type: object NoticeListResponse: additionalProperties: false properties: hasMore: description: Whether more notices exist beyond this page. type: boolean items: description: The page of notices (never null; empty when none). items: $ref: "#/components/schemas/NoticeResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the feed is exhausted. type: string required: - items - hasMore type: object NoticeResponse: additionalProperties: false properties: announcedAt: description: The sender's OWN announced instant (DtHrPart), verbatim. format: date-time type: string codMsg: description: Always GEN0015 — participante avisa arquivo disponível. type: string fileId: description: Identificador Arquivo; omitted when the file is attached to the message's USERMSG segment. type: string fileName: description: Nome Arquivo — the file the sender made available. type: string fileSize: description: Tamanho Arquivo in bytes, as the wire string; omitted when the file is attached to the message's USERMSG segment. type: string hash: description: Código Hash — the digest to verify the fetched file against, exactly as the sender wrote it (32 to 40 characters; usually a 40-hex SHA-1 or a 32-hex MD5, but the official type guarantees only the width). Omitted when the sender sent none. type: string history: description: Histórico — the sender's own description of the notice. type: string id: description: Notice id. format: uuid type: string ispbDestinatario: description: This institution's ISPB, as the sender addressed it. pattern: ^[0-9A-Z]{8}$ type: string ispbEmissor: description: The participant that announced the file. Verified against the certificate that sent the frame. pattern: ^[0-9A-Z]{8}$ type: string movementDate: description: Movement date (DtMovto), YYYY-MM-DD. format: date type: string numCtrlIF: description: The announcing participant's own control number for this notice. type: string numCtrlReqIFOr: description: Control number of the GEN0014 request this notice answers; omitted when the file was announced unprompted. type: string nuop: description: BCMSG unique operation number of the frame this row was projected from. type: string receivedAt: description: When this rail stored the notice. format: date-time type: string transmissionType: description: Tipo Transmissão, as sent. Its admissible values are defined per file in volume V of the Catálogo, so this rail surfaces it uninterpreted. type: string required: - id - codMsg - numCtrlIF - ispbEmissor - ispbDestinatario - transmissionType - fileName - history - announcedAt - movementDate - nuop - receivedAt type: object NotificationConfigResponse: additionalProperties: false properties: channels: description: Notification channels stored with this configuration (WEBHOOK, EMAIL). items: type: string type: array version: description: Optimistic-concurrency version; pass as expectedVersion on the next update. format: int64 type: integer windowLeadMinutes: description: Lead time (minutes) before a deposit-window close at which to fire the alert. format: int64 type: integer required: - windowLeadMinutes - channels - version type: object OutboundCloseRequestResponse: additionalProperties: false properties: id: description: Close request id. format: uuid type: string messageId: description: The outbound message the request is about. format: uuid type: string numCtrl: description: The câmara's own control number (NumCtrlPAG) the first operator read in the answer, for a SETTLED declaration of a PAG transfer; omitted otherwise. type: string outcome: description: What the operators declared from that answer; omitted for a close with no parked answer. enum: - SETTLED - FAILED type: string parkedAnswerId: description: The refused câmara answer the operators declared the outcome from; omitted for a close with no parked answer. format: uuid type: string reason: description: The evidence the first operator gave. type: string requestedAt: description: When the request was made. format: date-time type: string requestedBy: description: The operator who asked, as the audit trail names them. type: string settledAt: description: The settlement instant the operators confirmed for a SETTLED declaration; omitted otherwise. format: date-time type: string situation: description: The situation (SitLancPAG) the first operator read in the answer, for a SETTLED declaration of a PAG transfer; omitted otherwise. type: string status: description: PENDING until a second operator approves; APPROVED once the message is closed. enum: - PENDING - APPROVED type: string required: - id - messageId - requestedBy - reason - requestedAt - status type: object OutboundMessageListResponse: additionalProperties: false properties: items: description: The messages on this page, newest first (never null; empty when none match). items: $ref: "#/components/schemas/OutboundMessageResponse" type: array required: - items type: object OutboundMessageResponse: additionalProperties: false properties: answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer closeRequest: $ref: "#/components/schemas/OutboundCloseRequestResponse" description: The first operator's request to close this held message as failed, awaiting a second operator's approval; omitted when none awaits. codMsg: description: The SFN message code this row carries, e.g. LDL0023. type: string codProdt: description: The SILOC product, OT or SLC; omitted when the message's layout carries no product element. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string heldForAnswer: description: "True when the message's time ran out after a put whose outcome is unknown: it stays SUBMITTED for an answer the câmara may never send, and two operators can close it as failed (see requestOutboundMessageClose)." type: boolean id: description: Outbound message id. format: uuid type: string lastError: description: Why the last attempt failed, or that an LBTR message waits unsent for its cycle to open, which counts no attempt; omitted when neither applies. type: string nextAttemptAt: description: When the next queue put comes due; omitted once the row is terminal or answered. format: date-time type: string numCtrlIF: description: The control number this institution issued. The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string parkedAnswers: description: "The câmara answers parked unresolved for this held message; omitted when none. A message with one cannot be closed plainly: a SEMANTIC_REJECTED answer is declared by two operators as what its codMsg states (parkedAnswerId and outcome on the close request), any other can still replay." items: $ref: "#/components/schemas/ParkedAnswerResponse" type: array status: description: "Lifecycle state. REFUSED and FAILED are both terminal and are different facts: REFUSED means the câmara received the message and returned its E twin, FAILED means this rail could not deliver it and will not retry, or two operators closed a send whose outcome was unknown." enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the message was recorded. format: date-time type: string required: - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt - heldForAnswer type: object PAG0107Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [0..1]). type: string AgDebtd: description: Agência Debitada (Agencia, [1..1]). type: string CNPJ_CPFDestinatario: description: CNPJ ou CPF Destinatário (CNPJ_CPF, [1..1]). type: string CNPJ_CPFRemet: description: CNPJ ou CPF Remetente (CNPJ_CPF, [1..1]). type: string CodDocFis: description: Código Documento Fiscal (CodDocFis, [0..1]). Required when the Grupo_PAG0107_Split group is supplied; omit the whole group otherwise. type: string CtCredtd: description: Conta Creditada (CtBancaria, [0..1]). At most one of CtCredtd or CtPgtoCredtd. type: string CtPgtoCredtd: description: Conta Pagamento Creditada (CtPgto, [0..1]). At most one of CtCredtd or CtPgtoCredtd. type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string FinlddCli: description: Finalidade Cliente (FinlddCli, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomDestinatario: description: Nome Destinatário (Nome, [1..1]). type: string NomRemet: description: Nome Remetente (Nome, [1..1]). type: string TpCtCredtd: description: Tipo Conta Creditada (TpCt, [0..1]). type: string TpPessoaDestinatario: description: Tipo Pessoa Destinatário (TpPessoa, [1..1]). type: string TpPessoaRemet: description: Tipo Pessoa Remetente (TpPessoa, [1..1]). type: string VlrCBS: description: Valor CBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0107_Split group is supplied; omit the whole group otherwise. type: string VlrIBS: description: Valor IBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0107_Split group is supplied; omit the whole group otherwise. type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - AgDebtd - TpPessoaRemet - CNPJ_CPFRemet - NomRemet - ISPBIFCredtd - TpPessoaDestinatario - CNPJ_CPFDestinatario - NomDestinatario - VlrLanc - FinlddCli - DtMovto type: object PAG0108Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [0..1]). type: string AgDebtd: description: Agência Debitada (Agencia, [0..1]). type: string CNPJ_CPFCliCredtd: description: CNPJ ou CPF Cliente Creditado (CNPJ_CPF, [1..1]). type: string CNPJ_CPFCliDebtd: description: CNPJ ou CPF Cliente Debitado (CNPJ_CPF, [1..1]). type: string CodDocFis: description: Código Documento Fiscal (CodDocFis, [0..1]). Required when the Grupo_PAG0108_Split group is supplied; omit the whole group otherwise. type: string CodIdentdTransf: description: Código Identificador Transferência (CodIdentdTransf, [0..1]). type: string CtCredtd: description: Conta Creditada (CtBancaria, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtDebtd: description: Conta Debitada (CtBancaria, [0..1]). Exactly one of CtDebtd or CtPgtoDebtd is required. type: string CtPgtoCredtd: description: Conta Pagamento Creditada (CtPgto, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtPgtoDebtd: description: Conta Pagamento Debitada (CtPgto, [0..1]). Exactly one of CtDebtd or CtPgtoDebtd is required. type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string FinlddCli: description: Finalidade Cliente (FinlddCli, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomCliCredtd: description: Nome Cliente Creditado (Nome, [1..1]). type: string NomCliDebtd: description: Nome Cliente Debitado (Nome, [1..1]). type: string TpCtCredtd: description: Tipo Conta Creditada (TpCt, [1..1]). type: string TpCtDebtd: description: Tipo Conta Debitada (TpCt, [1..1]). type: string TpPessoaCredtd: description: Tipo Pessoa Creditada (TpPessoa, [1..1]). type: string TpPessoaDebtd: description: Tipo Pessoa Debitada (TpPessoa, [1..1]). type: string VlrCBS: description: Valor CBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0108_Split group is supplied; omit the whole group otherwise. type: string VlrIBS: description: Valor IBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0108_Split group is supplied; omit the whole group otherwise. type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - TpCtDebtd - TpPessoaDebtd - CNPJ_CPFCliDebtd - NomCliDebtd - ISPBIFCredtd - TpCtCredtd - TpPessoaCredtd - CNPJ_CPFCliCredtd - NomCliCredtd - VlrLanc - FinlddCli - DtMovto type: object PAG0111Payload: additionalProperties: false properties: CodDevTransf: description: Código Devolução Transferência (CodDevTransf, [1..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NumCtrlPAGOr: description: Número Controle PAG Original (ControleIF, [1..1]). type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - ISPBIFCredtd - VlrLanc - CodDevTransf - NumCtrlPAGOr - DtMovto type: object PAG0112Payload: additionalProperties: false properties: DtMovto: description: Data Movimento (xs:date, [1..1]). type: string NumCtrlPAGOr: description: "Número Controle PAG Original (ControleIF, [1..1]): the câmara's own control number for the pending entry being cancelled, as it answered on that entry (RPAG0003)." type: string required: - NumCtrlPAGOr - DtMovto type: object PAG0113Payload: additionalProperties: false properties: DtAgendt: description: Data Agendamento (xs:date, [0..1]). A filter on the date an entry was scheduled to settle (RSTR0011). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string HrIni: description: "Hora Início (xs:time, HH:MM:SS, [0..1]). A filter: omitting it means the câmara's opening time that day (RPAG0006)." type: string NumCtrlPAGOr: description: "Número Controle PAG Original (ControleIF, [0..1]). A filter: naming it returns only that entry (RPAG0005)." type: string SitLancPAG: description: "Situação Lançamento PAG (SitLancPAG, [0..1]). A filter, checked against the live set BACEN's Dicionário de Domínios publishes: AGE, CAN, COM, ENF or REJ (PEC and PED retired in 2002)." type: string TpDeb_Cred: description: "Tipo Débito ou Crédito (TpDebCred, [0..1]). A filter: C (crédito) or D (débito). Omit to ask for both." type: string required: - DtMovto type: object PAG0114Payload: additionalProperties: false properties: DtMovto: description: Data Movimento (xs:date, [1..1]). type: string required: - DtMovto type: object PAG0121Payload: additionalProperties: false properties: AgDebtd: description: Agência Debitada (Agencia, [0..1]). type: string CNPJ_CPFCliDebtd: description: CNPJ ou CPF Cliente Debitado (CNPJ_CPF, [1..1]). type: string CtDebtd: description: Conta Debitada (CtBancaria, [0..1]). At most one of CtDebtd or CtPgtoDebtd. type: string CtPgtoDebtd: description: Conta Pagamento Debitada (CtPgto, [0..1]). At most one of CtDebtd or CtPgtoDebtd. type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string IdentcDep: description: Identificação Depósito (IdentcDeposito, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomCliDebtd: description: Nome Cliente Debitado (Nome, [1..1]). type: string TpCtDebtd: description: Tipo Conta Debitada (TpCt, [0..1]). type: string TpPessoaDebtd: description: Tipo Pessoa Debitada (TpPessoa, [1..1]). type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - NomCliDebtd - TpPessoaDebtd - CNPJ_CPFCliDebtd - ISPBIFCredtd - VlrLanc - IdentcDep - DtMovto type: object PAG0122Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [0..1]). type: string AgDebtd: description: Agência Debitada (Agencia, [1..1]). type: string CNPJ_CPFCed: description: CNPJ ou CPF Cedente (CNPJ_CPF, [1..1]). type: string CNPJ_CPFSacd: description: CNPJ ou CPF Sacado (CNPJ_CPF, [1..1]). type: string CanPgto: description: Canal Pagamento (CanPgto, [1..1]). type: string CodIdentdTransf: description: Código Identificador Transferência (CodIdentdTransf, [0..1]). type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NumCodBarras: description: Número Código Barras (NumCodBarras, [1..1]). type: string TpDocBarras: description: Tipo Documento Barras (TpDocBarras, [1..1]). type: string TpPessoaCed: description: Tipo Pessoa Cedente (TpPessoa, [1..1]). type: string TpPessoaSacd: description: Tipo Pessoa Sacado (TpPessoa, [1..1]). type: string VlrDesct_Abatt: description: Valor Desconto ou Abatimento (Valor, [0..1]). type: string VlrDoc: description: Valor Documento (Valor, [0..1]). type: string VlrJuros: description: Valor Juros (Valor, [0..1]). type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string VlrMulta: description: Valor Multa (Valor, [0..1]). type: string VlrOtrAcresc: description: Valor Outros Acréscimos (Valor, [0..1]). type: string required: - AgDebtd - ISPBIFCredtd - VlrLanc - TpPessoaSacd - CNPJ_CPFSacd - TpPessoaCed - CNPJ_CPFCed - TpDocBarras - NumCodBarras - CanPgto - DtMovto type: object PAG0134Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [0..1]). type: string AgDebtd: description: Agência Debitada (Agencia, [0..1]). type: string CNPJ_CPFCliCredtd: description: CNPJ ou CPF Cliente Creditado (CNPJ_CPF, [1..1]). type: string CNPJ_CPFCliDebtd: description: CNPJ ou CPF Cliente Debitado (CNPJ_CPF, [1..1]). type: string CNPJ_CPFInvest: description: CNPJ ou CPF Investidor (CNPJ_CPF, [1..1]). type: string CodCli: description: Código Cliente (CodCli, [0..1]). type: string CodDocFis: description: Código Documento Fiscal (CodDocFis, [0..1]). Required when the Grupo_PAG0134_Split group is supplied; omit the whole group otherwise. type: string CtCredtd: description: Conta Creditada (CtBancaria, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtDebtd: description: Conta Debitada (CtBancaria, [0..1]). Exactly one of CtDebtd or CtPgtoDebtd is required. type: string CtPgtoCredtd: description: Conta Pagamento Creditada (CtPgto, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtPgtoDebtd: description: Conta Pagamento Debitada (CtPgto, [0..1]). Exactly one of CtDebtd or CtPgtoDebtd is required. type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string FinlddCli: description: Finalidade Cliente (FinlddCli, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomCliCredtd: description: Nome Cliente Creditado (Nome, [1..1]). type: string NomCliDebtd: description: Nome Cliente Debitado (Nome, [1..1]). type: string Nom_RzSocInvest: description: Nome ou Razão Social Investidor (Nome, [1..1]). type: string TpCtCredtd: description: Tipo Conta Creditada (TpCt, [1..1]). type: string TpCtDebtd: description: Tipo Conta Debitada (TpCt, [1..1]). type: string TpPessoaCredtd: description: Tipo Pessoa Creditada (TpPessoa, [1..1]). type: string TpPessoaDebtd: description: Tipo Pessoa Debitada (TpPessoa, [1..1]). type: string TpPessoaInvest: description: Tipo Pessoa Investidor (TpPessoa, [1..1]). type: string VlrCBS: description: Valor CBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0134_Split group is supplied; omit the whole group otherwise. type: string VlrIBS: description: Valor IBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0134_Split group is supplied; omit the whole group otherwise. type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - TpCtDebtd - TpPessoaDebtd - CNPJ_CPFCliDebtd - NomCliDebtd - ISPBIFCredtd - TpCtCredtd - TpPessoaCredtd - CNPJ_CPFCliCredtd - NomCliCredtd - VlrLanc - FinlddCli - TpPessoaInvest - CNPJ_CPFInvest - Nom_RzSocInvest - DtMovto type: object PAG0137Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [0..1]). type: string AgDebtd: description: Agência Debitada (Agencia, [0..1]). type: string CPFCliDebtd: description: CPF Cliente Debitado (CPF, [1..1]). type: string CodIdentdTransf: description: Código Identificador Transferência (CodIdentdTransf, [0..1]). type: string CtCredtd: description: Conta Creditada (CtBancaria, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtDebtd: description: Conta Debitada (CtBancaria, [0..1]). Exactly one of CtDebtd or CtPgtoDebtd is required. type: string CtPgtoCredtd: description: Conta Pagamento Creditada (CtPgto, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtPgtoDebtd: description: Conta Pagamento Debitada (CtPgto, [0..1]). Exactly one of CtDebtd or CtPgtoDebtd is required. type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomCliDebtd: description: Nome Cliente Debitado (Nome, [1..1]). type: string TpCtCredtd: description: Tipo Conta Creditada (TpCt, [1..1]). type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - CPFCliDebtd - NomCliDebtd - ISPBIFCredtd - TpCtCredtd - VlrLanc - DtMovto type: object PAG0141Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [1..1]). type: string AgDebtd: description: Agência Debitada (Agencia, [0..1]). type: string CPFCliCredtd: description: CPF Cliente Creditado (CPF, [1..1]). type: string CodIdentdTransf: description: Código Identificador Transferência (CodIdentdTransf, [0..1]). type: string CtCredtd: description: Conta Creditada (CtBancaria, [0..1]). type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Hist: description: Histórico (Historico, [1..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomCliCredtd: description: Nome Cliente Creditado (Nome, [1..1]). type: string NumBenfcINSSCliCredtd: description: Número Benefício INSS Cliente Creditado (NumBenfcINSS, [1..1]). type: string NumContrtoOpCred: description: Número Contrato Operação Crédito (NumContrtoOpCred, [1..1]). type: string NumProtAvebcINSS: description: Número Protocolo Averbação INSS (NumProtINSS, [1..1]). type: string TpBenfcINSS: description: Tipo Benefício INSS (TpBenfcINSS, [1..1]). type: string TpOpEmprtConsigd: description: Tipo Operação Empréstimo Consignado (TpOpEmprtConsigd, [1..1]). type: string VlrCredConsigd: description: Valor Crédito Consignado (Valor, [1..1]). type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string VlrTarBcoCredtd: description: Valor Tarifa Banco Creditado (Valor, [1..1]). type: string required: - ISPBIFCredtd - AgCredtd - NumBenfcINSSCliCredtd - TpBenfcINSS - CPFCliCredtd - NomCliCredtd - NumContrtoOpCred - NumProtAvebcINSS - TpOpEmprtConsigd - VlrCredConsigd - VlrTarBcoCredtd - VlrLanc - Hist - DtMovto type: object PAG0142Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [0..1]). type: string AgDebtd: description: Agência Debitada (Agencia, [0..1]). type: string CNPJ_CPFCliDebtd_Remet: description: CNPJ ou CPF Cliente Debitado ou Remetente (CNPJ_CPF, [1..1]). type: string CNPJ_CPFDestinatario: description: CNPJ ou CPF Destinatário (CNPJ_CPF, [0..1]). type: string CodIdentdTransf: description: Código Identificador Transferência (CodIdentdTransf, [0..1]). type: string CtCredtd: description: Conta Creditada (CtBancaria, [0..1]). type: string CtDebtd: description: Conta Debitada (CtBancaria, [0..1]). At most one of CtDebtd or CtPgtoDebtd. type: string CtPgtoDebtd: description: Conta Pagamento Debitada (CtPgto, [0..1]). At most one of CtDebtd or CtPgtoDebtd. type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string FinlddCliVarj: description: Finalidade Cliente Varejo (FinlddCliVarj, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomCliDebtd_Remet: description: Nome Cliente Debitado ou Remetente (Nome, [1..1]). type: string NomDestinatario: description: Nome Destinatário (Nome, [0..1]). type: string NumContrtoOpCred: description: Número Contrato Operação Crédito (NumContrtoOpCred, [0..1]). type: string TpCtDebtd: description: Tipo Conta Debitada (TpCt, [0..1]). Required when the Grupo_PAG0142_CtDebtd group is supplied; omit the whole group otherwise. type: string TpPessoaDebtd_Remet: description: Tipo Pessoa Debitada ou Remetente (TpPessoa, [1..1]). type: string TpPessoaDestinatario: description: Tipo Pessoa Destinatário (TpPessoa, [0..1]). type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - TpPessoaDebtd_Remet - CNPJ_CPFCliDebtd_Remet - NomCliDebtd_Remet - ISPBIFCredtd - VlrLanc - FinlddCliVarj - DtMovto type: object PAG0143Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [0..1]). type: string CNPJ_CPFCliCredtd: description: CNPJ ou CPF Cliente Creditado (CNPJ_CPF, [1..1]). type: string CNPJ_CPFRemet: description: CNPJ ou CPF Remetente (CNPJ_CPF, [0..1]). type: string CodDocFis: description: Código Documento Fiscal (CodDocFis, [0..1]). Required when the Grupo_PAG0143_Split group is supplied; omit the whole group otherwise. type: string CodIdentdTransf: description: Código Identificador Transferência (CodIdentdTransf, [0..1]). type: string CtCredtd: description: Conta Creditada (CtBancaria, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtPgtoCredtd: description: Conta Pagamento Creditada (CtPgto, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string FinlddIFVarj: description: Finalidade IF Varejo (FinlddIFVarj, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomCliCredtd: description: Nome Cliente Creditado (Nome, [1..1]). type: string NomRemet: description: Nome Remetente (Nome, [0..1]). type: string NumContrtoOpCred: description: Número Contrato Operação Crédito (NumContrtoOpCred, [0..1]). type: string TpCtCredtd: description: Tipo Conta Creditada (TpCt, [1..1]). type: string TpPessoaCredtd: description: Tipo Pessoa Creditada (TpPessoa, [1..1]). type: string TpPessoaRemet: description: Tipo Pessoa Remetente (TpPessoa, [0..1]). type: string VlrCBS: description: Valor CBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0143_Split group is supplied; omit the whole group otherwise. type: string VlrIBS: description: Valor IBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0143_Split group is supplied; omit the whole group otherwise. type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - ISPBIFCredtd - TpCtCredtd - TpPessoaCredtd - CNPJ_CPFCliCredtd - NomCliCredtd - VlrLanc - FinlddIFVarj - DtMovto type: object PAG0151Payload: additionalProperties: false properties: AgCredtd: description: Agência Creditada (Agencia, [0..1]). type: string AgDebtd: description: Agência Debitada (Agencia, [0..1]). type: string CNPJ_CPFCliCredtd: description: CNPJ ou CPF Cliente Creditado (CNPJ_CPF, [1..1]). type: string CNPJ_CPFCliDebtd: description: CNPJ ou CPF Cliente Debitado (CNPJ_CPF, [0..1]). type: string CodTribl: description: Código Tribunal (CodTribl, [1..1]). type: string CtCredtd: description: Conta Creditada (CtBancaria, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtDebtd: description: Conta Debitada (CtBancaria, [0..1]). At most one of CtDebtd or CtPgtoDebtd. type: string CtPgtoCredtd: description: Conta Pagamento Creditada (CtPgto, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required. type: string CtPgtoDebtd: description: Conta Pagamento Debitada (CtPgto, [0..1]). At most one of CtDebtd or CtPgtoDebtd. type: string DtAgendt: description: Data Agendamento (xs:date, [0..1]). type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string ISPBIFCredtd: description: ISPB IF Creditada (ISPB, [1..1]). type: string NivelPrefPAG: description: Nível Preferência PAG (PrefPAG, [0..1]). type: string NomAutor: description: Nome Autor (Nome, [0..1]). type: string NomCliCredtd: description: Nome Cliente Creditado (Nome, [1..1]). type: string NomCliDebtd: description: Nome Cliente Debitado (Nome, [0..1]). type: string NomReu: description: Nome Réu (Nome, [0..1]). type: string NomTribl: description: Nome Tribunal (NomEstend, [1..1]). type: string NumProcJud: description: Número Processo Judicial (NumProcJud, [1..1]). type: string TpCtCredtd: description: Tipo Conta Creditada (TpCt, [1..1]). type: string TpPessoaCredtd: description: Tipo Pessoa Creditada (TpPessoa, [1..1]). type: string TpPessoaDebtd: description: Tipo Pessoa Debitada (TpPessoa, [0..1]). type: string VlrLanc: description: Valor Lançamento (Valor, [1..1]). type: string required: - ISPBIFCredtd - TpCtCredtd - TpPessoaCredtd - CNPJ_CPFCliCredtd - NomCliCredtd - VlrLanc - NomTribl - CodTribl - NumProcJud - DtMovto type: object PAG0201Payload: additionalProperties: false properties: DtAltSit: description: "Data Alteração Situação (xs:date, [1..1]): the day the participant becomes inoperante. The câmara requires it to differ from the current date (RPAG0007)." type: string DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string required: - DtAltSit - DtMovto type: object PAG0202Payload: additionalProperties: false properties: DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string required: - DtMovto type: object PAG0203Payload: additionalProperties: false properties: DtMovto: description: Data Movimento (xs:date, [1..1]). type: string Hist: description: Histórico (Historico, [0..1]). type: string NumCtrlPAGOr: description: "Número Controle PAG Original (ControleIF, [1..1]): the câmara's own control number for the situação change being withdrawn, as it answered on that change." type: string required: - NumCtrlPAGOr - DtMovto type: object PAGControlAnswerResponse: additionalProperties: false properties: codMsg: description: The answer's own code, e.g. PAG0112R1. type: string entries: description: The PAG0113 result, in the order the câmara sent it; empty for every other code. An empty list means no entry matched the filters — never that no instruction was sent, because the câmara never presents a message it refused (RPAG0004). items: $ref: "#/components/schemas/PAGQueriedEntryResponse" type: array movementDate: description: Data Movimento. format: date type: string numCtrlPAG: description: "Número Controle PAG: the câmara's own control number for what it registered. Omitted on the two consultations (PAG0113, PAG0114), whose answers register nothing to number." type: string pagAt: description: "Data Hora PAG: the câmara's clock, verbatim." format: date-time type: string periods: description: The PAG0114 synthetic statement, one row per operational period, in the order the câmara sent it; empty for every other code. items: $ref: "#/components/schemas/PAGStatementPeriodResponse" type: array required: - codMsg - pagAt - movementDate - entries - periods type: object PAGCreditNoticeListResponse: additionalProperties: false properties: hasMore: description: Whether more notices exist beyond this page. type: boolean items: description: The page of notices (never null; empty when none). items: $ref: "#/components/schemas/PAGCreditNoticeResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the feed is exhausted. type: string required: - items - hasMore type: object PAGCreditNoticeResponse: additionalProperties: false properties: codDevTransf: description: "PAG0111R2 only: Código Devolução Transferência, as sent." type: string codIdentdTransf: description: Código Identificador Transferência, when the layout carries it and the câmara sent it. type: string codMsg: description: The R2 code the câmara sent, e.g. PAG0107R2 ("Resposta a Terceiros" of PAG0107). type: string hist: description: Histórico, when sent. type: string id: description: Stored notice id. format: uuid type: string ispbIFCredtd: description: This institution, as the câmara addressed it. pattern: ^[0-9A-Z]{8}$ type: string ispbIFDebtd: description: The institution that requested the transfer. pattern: ^[0-9A-Z]{8}$ type: string movementDate: description: Movement date (DtMovto), YYYY-MM-DD. format: date type: string numCtrlPAG: description: Número Controle PAG, the câmara's own control number for the movement. A devolução of it names this value as NumCtrlPAGOr. type: string numCtrlPAGOr: description: "PAG0111R2 only: the câmara control number of the movement this devolução returns." type: string nuop: description: BCMSG unique operation number of the delivered frame. type: string postedAt: description: The câmara's own instant (DtHrPAG), verbatim. format: date-time type: string rawBody: contentEncoding: base64 description: The decrypted RSFN document exactly as delivered (UTF-16 BE bytes, base64 on the wire), carrying every field of this code's layout. type: string receivedAt: description: When this rail stored the notice. format: date-time type: string vlrLanc: description: "Valor Lançamento, the posted amount as the decimal string the câmara sent (never parsed into a number)." type: string required: - id - codMsg - numCtrlPAG - ispbIFDebtd - ispbIFCredtd - vlrLanc - postedAt - movementDate - nuop - rawBody - receivedAt type: object PAGQueriedEntryResponse: additionalProperties: false properties: codMsgOr: description: "Código Mensagem Original: the code of the instruction this entry came from, e.g. PAG0107." type: string ispbIFCtrapart: description: "ISPB IF Contraparte: the counterparty institution." type: string numCtrlPAGOr: description: "Número Controle PAG Original: the câmara's own control number for this entry, and the value a cancellation (PAG0112) or a devolução (PAG0111) names." type: string scheduleDate: description: "Data Agendamento: the day this entry is scheduled to settle. Omitted when the câmara sent none." format: date type: string sitLancPAG: description: Situação Lançamento PAG, exactly as the câmara wrote it. Its values are published in BACEN's separate Dicionário de Domínios, each with its own activation and deactivation dates, so this rail neither decodes it nor asserts a settlement outcome from it. type: string situationAt: description: "Data Hora Situação: the câmara's clock for this entry's situação." format: date-time type: string tpDebCred: description: "Tipo Débito ou Crédito, verbatim: C or D in the set BACEN publishes today." type: string vlrLanc: description: Valor Lançamento, as the decimal STRING the câmara wrote — never re-rendered through a number, so no centavo moves between the wire and this field. type: string required: - codMsgOr - tpDebCred - ispbIFCtrapart - numCtrlPAGOr - situationAt - sitLancPAG - vlrLanc type: object PAGStatementPeriodResponse: additionalProperties: false properties: balance: description: "Saldo Período: the câmara's own closing balance for the period, as it wrote it. This rail does not derive it and does not check that it reconciles." type: string codPerOperac: description: Código Período Operacional, verbatim. type: string complementaryDeposits: description: Total Depósito Complementar Período, as the câmara wrote it. type: string initialDeposit: description: Valor Depósito Inicial Período, as the câmara wrote it. type: string totalCredits: description: Valor Total Lançamento Crédito, as the câmara wrote it. type: string totalDebits: description: Valor Total Lançamento Débito, as the câmara wrote it. type: string required: - codPerOperac - initialDeposit - complementaryDeposits - totalDebits - totalCredits - balance type: object PAGTransferAnswerResponse: additionalProperties: false properties: codMsg: description: The answer's own code, e.g. PAG0107R1. type: string movementDate: description: Data Movimento. format: date type: string numCtrlPAG: description: "Número Controle PAG: the CÂMARA's own control number for the movement. A later devolução (PAG0111) names it as NumCtrlPAGOr, so it is the identifier needed to reverse this transfer." type: string sitLancPAG: description: Situação Lançamento PAG, exactly as the câmara wrote it. Its values are published in BACEN's separate Dicionário de Domínios (AGE, CAN, COM, ENF, PEC, PED, REJ), each with its own activation and deactivation dates, so this rail neither decodes it nor asserts a settlement outcome from it — read it against the dictionary version you hold. type: string situationAt: description: "Data Hora Situação: the câmara's clock, verbatim." format: date-time type: string required: - codMsg - numCtrlPAG - sitLancPAG - situationAt - movementDate type: object PagControlBodyPAG0112Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGControlAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0112. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0112Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagControlBodyPAG0113Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGControlAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0112. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0113Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagControlBodyPAG0114Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGControlAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0112. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0114Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagControlBodyPAG0201Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGControlAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0112. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0201Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagControlBodyPAG0202Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGControlAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0112. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0202Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagControlBodyPAG0203Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGControlAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0112. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0203Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0107Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0107Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0108Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0108Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0111Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0111Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0121Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0121Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0122Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0122Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0134Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0134Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0137Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0137Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0141Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0141Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0142Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0142Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0143Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0143Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object PagTransferBodyPAG0151Payload: additionalProperties: false properties: answer: $ref: "#/components/schemas/PAGTransferAnswerResponse" description: "What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET." answerAbsent: description: True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise, and always on the submit (POST) receipt. type: boolean answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer codMsg: description: The SFN instruction code this row carries, e.g. PAG0107. type: string dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string id: description: Outbound message id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string request: $ref: "#/components/schemas/PAG0151Payload" description: The request exactly as it was submitted, projected verbatim. status: description: Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the instruction was recorded. format: date-time type: string required: - request - id - codMsg - numCtrlIF - nuop - status - attempts - submittedAt type: object ParkedAnswerResponse: additionalProperties: false properties: codMsg: description: "The answer's own message code: an R1 (for example LTR0002R1) says the câmara took the message, an E twin (LTR0002E) says it refused it." type: string id: description: Parked-message id, the same the DLQ read lists. format: uuid type: string payload: contentEncoding: base64 description: The answer exactly as the rail received it, base64 (the SISMSG document); an operator declaring the held message reads the câmara's answer here. type: string rejectReason: description: Why the rail refused a SEMANTIC_REJECTED answer; omitted otherwise. type: string status: description: PENDING and PROCESSING can still replay and settle the message; SEMANTIC_REJECTED is terminal, the rail refused it on content and never applies it. enum: - PENDING - PROCESSING - SEMANTIC_REJECTED type: string required: - id - codMsg - status - payload type: object ParticipantListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of participants (never null). items: $ref: "#/components/schemas/ParticipantResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object ParticipantProductStatusResponse: additionalProperties: false properties: noticeAt: description: DtHrPAG of the notice that last moved this status. format: date-time type: string product: description: CodProdt the notice asserted the situation for. examples: - OT type: string status: description: PAG0101 operational status. enum: - "1" - "2" - "3" - "6" - "7" - "8" - "9" type: string required: - product - status - noticeAt type: object ParticipantResponse: additionalProperties: false properties: createdAt: description: Creation timestamp. format: date-time type: string id: description: Participant id. format: uuid type: string ispb: description: 8-digit BACEN ISPB. examples: - "46026562" pattern: ^[0-9]{8}$ type: string name: description: Participant legal name. maxLength: 200 type: string role: description: Participant role. enum: - DIRECT - INDIRECT - SETTLING_INSTITUTION type: string settlingInstitutionIspb: description: For an indirect participant, the ISPB of its settling institution. pattern: ^[0-9]{8}$ type: string statuses: description: The câmara's standing operational situation, one entry per product a PAG0101 has named (never null; empty when none has). items: $ref: "#/components/schemas/ParticipantProductStatusResponse" type: array updatedAt: description: Last-update timestamp. format: date-time type: string required: - id - ispb - role - name - statuses - createdAt - updatedAt type: object ParticipantStatusEventResponse: additionalProperties: false properties: effectiveAt: description: When the status took effect. format: date-time type: string product: description: CodProdt the notice asserted the situation for. examples: - OT type: string source: description: Origin of the status change (e.g. PAG0101 message reference). type: string status: description: PAG0101 operational status (SitOperacIFCamr), verbatim. EMPTY when the notice carried an empty status, which the official type admits (minimum length 0); an empty entry is history only and is never the current status. enum: - "" - "1" - "2" - "3" - "6" - "7" - "8" - "9" type: string required: - product - status - effectiveAt type: object ParticipantStatusResponse: additionalProperties: false properties: current: $ref: "#/components/schemas/ParticipantStatusEventResponse" description: The current operational status. ABSENT when no PAG0101 has named this institution for this product — an institution the câmara has not spoken about has no operating situation, and reporting a defaulted one would claim a notice said something it did not. history: description: The status history, newest first (never null). items: $ref: "#/components/schemas/ParticipantStatusEventResponse" type: array participantId: description: Participant id. format: uuid type: string product: description: The product this answer is about. examples: - OT type: string required: - participantId - product - history type: object PositionQueryInputBody: additionalProperties: false properties: cnpjNLiqdant: description: Narrow to one non-settling member. maxLength: 14 type: string identdPartCamr: description: Narrow to one câmara participant. maxLength: 8 type: string ispbIFLiqdant: description: Narrow to one COUNTERPARTY settlement bank (rule RLTR0003). maxLength: 8 type: string movementDate: description: The movement date (DtMovto), YYYY-MM-DD. The only required field. format: date type: string numCtrlLTROr: description: Narrow to one announced result. maxLength: 20 type: string numOpLTR: description: Narrow to one gross operation. maxLength: 20 type: string sitLancLTR: description: Narrow to one posting situation; numeric, carried verbatim. maxLength: 3 type: string tpDebCred: description: Narrow to debits (D) or credits (C), the Dicionário de Domínios TpDebCred values. maxLength: 1 type: string required: - movementDate type: object ProductBilateralLine: additionalProperties: false properties: amount: description: VlrBilatProdt, the wire string with its decimal comma. type: string clientId: description: CodCliPrestd; omitted when absent. type: string clientName: description: NomCliPrestd; omitted when absent. type: string debitCredit: description: "TpDeb_CredBilatProdt as sent: C or D." type: string ispb: description: ISPBIFBilatProdt, the counterparty. type: string required: - ispb - debitCredit - amount type: object ProductResult: additionalProperties: false properties: amount: description: VlrMultlatProdt, the wire string with its decimal comma. type: string counterparties: description: Grupo_BilatProdt, in wire order. items: $ref: "#/components/schemas/ProductBilateralLine" type: array debitCredit: description: "TpDeb_CredMultlatProdt as sent: C or D." type: string product: description: CodProdt, OT for the SILOC. type: string required: - product - debitCredit - amount - counterparties type: object QuarantineResolveResponse: additionalProperties: false properties: id: description: The resolved quarantined-frame id. format: uuid type: string status: description: Resolve outcome. examples: - resolved type: string required: - id - status type: object QuarantinedFrameListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of quarantined frames (never null). items: $ref: "#/components/schemas/QuarantinedFrameResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object QuarantinedFrameResponse: additionalProperties: false properties: createdAt: description: When the frame was quarantined. format: date-time type: string evidence: description: "Queue-manager facts identifying the parked frame: refusal count, MQMD message id, the receive queue, the original put stamp, and whether the stored bytes are a prefix." type: string frame: contentEncoding: base64 description: "The parked frame, base64, exactly as it arrived: the SFN envelope with SISMSG still encrypted to this institution's key, and only a prefix when the evidence says it was truncated. The only copy once the frame left the queue." type: string id: description: Quarantined-frame id; the resolve handle. format: uuid type: string required: - id - evidence - frame - createdAt type: object RecalculationChainResponse: additionalProperties: false properties: cycleId: description: Cycle whose recálculo chain this is. format: uuid type: string items: description: The recálculo rounds, oldest first (never null; empty when the cycle never entered recálculo). items: $ref: "#/components/schemas/RecalculationRoundResponse" type: array residualNote: description: "Fixed note: a post-exclusion residual is a bilateral participant-responsibility TED, surfaced not routed." type: string required: - cycleId - items - residualNote type: object RecalculationRoundResponse: additionalProperties: false properties: complementWindowClosesAt: description: Received complement/deposit deadline for the round; a later round surfaces the +15min prorrogation as its own window. format: date-time type: string defaultingParticipantIspb: description: ISPB of the participant the PAG0101 exclusion notice named. type: string depositAdvisoryId: description: ce-id of the deposit-required advisory Lerian SILOC emitted for this round, the advisoryId the Lerian SPB deposit command names; omitted for a credit or a zero round. format: uuid type: string lastFundingAck: $ref: "#/components/schemas/FundingAckResponse" description: The round's proof as recorded; a refused deposit's gives way to the redeposit's. Omitted until one lands. recomputedAmount: description: Recomputed obligation magnitude (NUMERIC(19,2)), decimal string, projected verbatim. type: string recomputedSide: description: Explicit money direction of the recomputed obligation (never derived from a sign). enum: - DEBIT - CREDIT type: string resolution: description: Lerian SILOC-internal audit label; omitted while the round is pending. enum: - COMPLEMENTED - EXCLUDED type: string round: description: Recálculo iteration number for the cycle (1, 2, 3, …). format: int64 type: integer required: - round - defaultingParticipantIspb - recomputedSide - recomputedAmount - complementWindowClosesAt type: object ReconciliationResponse: additionalProperties: false properties: clearingAmount: description: The GEN0015 result's VlrMultlatBco in canonical form (evidence); omitted when it is not a readable Valor. type: string cycleId: description: Reconciled cycle id. format: uuid type: string matched: description: True iff reason == MATCHED. type: boolean mismatchDetail: description: Explanation for a non-MATCHED outcome. type: string reason: description: Deterministic outcome class. enum: - SOURCE_MISSING - MATCHED - SIDE_MISMATCH - AMOUNT_MISMATCH type: string reconciledAt: description: Reconciliation instant. format: date-time type: string resultNoticeId: description: The GEN0015 notice whose multilateral result was compared; omitted for SOURCE_MISSING. format: uuid type: string settledAmount: description: The obligation's canonical magnitude (evidence). type: string required: - cycleId - reason - matched - reconciledAt type: object RecordScheduleChangeInputBody: additionalProperties: false properties: effectiveAt: description: The announced instant the change takes effect (RFC3339); with windowSeq 1 or 2, the announced new deposit close, which moves that window's WINDOW_CLOSING deadline and must fall on the window's São Paulo date, no earlier than it opens (else 422; record a close after midnight without windowSeq); with windowSeq 3, the extended LBTR close, after its movement day's 17h30 and before the next day's 06h40 LBTR open, so a close past midnight extends the day before (else 422). format: date-time type: string origin: description: The announcing channel / upstream reference (non-empty, ≤256 chars). maxLength: 256 type: string reason: description: Why the schedule changed (non-empty, ≤500 chars). maxLength: 500 type: string windowSeq: description: The affected canonical window's grid sequence (1 or 2, validated against the compiled window grid), or 3 for the card LBTR cycle's close that Núclea announces when it extends the grade on a day BACEN declares the STR down; omit for a non-window-specific note. format: int64 minimum: 1 type: integer required: - reason - origin - effectiveAt type: object RegisterCertificateRequest: additionalProperties: false properties: custodyReference: description: Reference locating the private key in the FI's custody (HSM/KMIP). type: string publicCertificatePem: description: PEM-encoded public certificate. The private key is NOT transmitted. type: string sfnCertificateId: description: "Exact 64-hex C11 identity assigned to this certificate: the hex encoding of the 32-byte slot, whose content is the certificate serial in uppercase ASCII hex, right-aligned and zero-left-padded. No ISPB. Unique only within the authority derived from the certificate." maxLength: 64 minLength: 64 type: string required: - publicCertificatePem - custodyReference - sfnCertificateId type: object RegisterParticipantRequest: additionalProperties: false properties: ispb: description: 8-digit BACEN ISPB. examples: - "46026562" pattern: ^[0-9]{8}$ type: string name: description: Participant legal name. maxLength: 200 type: string role: description: Participant role. enum: - DIRECT - INDIRECT - SETTLING_INSTITUTION type: string settlingInstitutionIspb: description: Required when role is INDIRECT. pattern: ^[0-9]{8}$ type: string required: - ispb - role - name type: object RelayFailureListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of parked relay failures (never null). items: $ref: "#/components/schemas/RelayFailureResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object RelayFailureResponse: additionalProperties: false properties: createdAt: description: When the frame was parked. format: date-time type: string id: description: Parked-frame id; the replay handle. format: uuid type: string messageType: description: SILOC/SFN message family parked (funding/clearing). examples: - LDL0021 type: string reason: description: Why the frame was parked. examples: - RELAY_FAILED type: string replayable: description: Whether the frame is eligible for replay. type: boolean required: - id - reason - replayable - createdAt type: object RelayReplayResponse: additionalProperties: false properties: id: description: The replayed parked-frame id. format: uuid type: string status: description: Replay outcome. examples: - replayed type: string required: - id - status type: object RelayStatusResponse: additionalProperties: false properties: cardSettlementBlocked: description: True when the relay is down and the card product cannot reach SILOC. type: boolean health: description: The card-domain relay's health. enum: - HEALTHY - DEGRADED - DOWN type: string lagMessages: description: Approximate number of buffered/undelivered relayed messages. format: int64 type: integer lastRelayedAt: description: When the most recent frame was relayed; omitted when nothing has been relayed. format: date-time type: string required: - health - cardSettlementBlocked type: object RelayedMessageListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of relayed messages (never null). items: $ref: "#/components/schemas/RelayedMessageResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object RelayedMessageResponse: additionalProperties: false properties: businessKey: description: Correlation key carried on the relayed message (the NUOp). type: string direction: description: Message direction relative to the rail. enum: - INBOUND - OUTBOUND type: string id: description: Relayed-message audit id. format: uuid type: string messageType: description: SILOC/SFN message family relayed (funding/clearing). examples: - LDL0021 type: string relayedAt: description: When the frame was relayed. format: date-time type: string required: - id - direction - messageType - relayedAt type: object ResultDecisionInputBody: additionalProperties: false properties: decidedAt: description: The deciding institution's own clock (DtHrIF). format: date-time type: string movementDate: description: The movement date (DtMovto), YYYY-MM-DD. format: date type: string numCtrlLTROr: description: The câmara's control number on the LTR0001 being answered (NumCtrlLTROr). maxLength: 20 minLength: 1 type: string tpConfDivg: description: "Tipo Confirma ou Diverge: C (Confirma) or D (Diverge), the Dicionário de Domínios TpConfDivg values." maxLength: 1 minLength: 1 type: string required: - numCtrlLTROr - tpConfDivg - decidedAt - movementDate type: object ScheduleChangeListResponse: additionalProperties: false properties: hasMore: description: Whether more schedule changes exist beyond this page. type: boolean items: description: The page of schedule changes (never null; empty when none). items: $ref: "#/components/schemas/ScheduleChangeResponse" type: array nextCursor: description: Opaque cursor for the next page; omitted when the feed is exhausted. type: string required: - items - hasMore type: object ScheduleChangeResponse: additionalProperties: false properties: announcedAt: description: When the change was recorded (intake instant). format: date-time type: string effectiveAt: description: The announced instant the change takes effect, recorded verbatim (for a window prorrogação, the announced new close). format: date-time type: string id: description: Schedule change id. format: uuid type: string origin: description: Auditable origin — the announcing channel / upstream reference (e.g. "Núclea e-mail ref X"). type: string reason: description: Why the schedule changed, as recorded by the operator. type: string windowSeq: description: The affected canonical window's grid sequence (1 or 2), or 3 for the LBTR close; omitted for a non-window-specific note. format: int64 type: integer required: - id - reason - effectiveAt - origin - announcedAt type: object ScheduleQueryGridResponse: additionalProperties: false properties: closesAt: description: Data Hora Fechamento, the câmara's clock, verbatim. format: date-time type: string codGrdLDL: description: Código Grade LDL, the câmara's own 5-character grid code. type: string opensAt: description: Data Hora Abertura, the câmara's clock, verbatim. format: date-time type: string scheduleType: description: Tipo Horário, verbatim. Documented values are P and E; the official type enumerates nothing, so a third value is shown rather than refused. type: string required: - codGrdLDL - opensAt - closesAt - scheduleType type: object ScheduleQueryResponse: additionalProperties: false properties: answeredAt: description: When the câmara's answer was applied; omitted until it is. format: date-time type: string attempts: description: Queue-put attempts made so far. format: int64 type: integer dispatchedAt: description: When the frame reached the send queue; omitted until it has. format: date-time type: string grids: description: "The grades de horário the answer returned (never null; empty until the câmara answers, and always empty on the submit (POST) receipt, which states the query and its current status only: read the grids with GET)." items: $ref: "#/components/schemas/ScheduleQueryGridResponse" type: array id: description: Schedule query id. format: uuid type: string lastError: description: Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies, and always on the submit (POST) receipt. type: string numCtrlIF: description: The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two. type: string nuop: description: The BCMSG operation number of the frame. type: string referenceDate: description: The date asked about (DtRef). format: date type: string scheduleType: description: P (padrão) or E (eventual); omitted when the query did not constrain the type. type: string status: description: Lifecycle state. REFUSED means the câmara received the query and returned its E twin (LDL0023E); FAILED means this rail could not deliver it. Both are terminal and they are different facts. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string submittedAt: description: When the query was recorded. format: date-time type: string required: - id - numCtrlIF - nuop - referenceDate - status - attempts - submittedAt - grids type: object ScheduleWindowListResponse: additionalProperties: false properties: items: description: The compiled canonical OT window grid (never null). items: $ref: "#/components/schemas/Window" type: array required: - items type: object SettlementInstructionListResponse: additionalProperties: false properties: hasMore: description: Whether more pages follow. type: boolean items: description: The page of instructions (never null). items: $ref: "#/components/schemas/SettlementInstructionResponse" type: array nextCursor: description: Opaque cursor for the next page; empty when exhausted. type: string required: - items - hasMore type: object SettlementInstructionResponse: additionalProperties: false properties: amountCanonical: description: Canonical NUMERIC(19,2), decimal string. type: string amountRaw: description: VlrLanc verbatim (validated magnitude). type: string createdAt: description: Row creation instant (list cursor key). format: date-time type: string cycleId: description: Correlated cycle id (1:1). format: uuid type: string depositAdvisoryId: description: ce-id of the deposit-required advisory Lerian SILOC emitted for this obligation, the advisoryId the Lerian SPB deposit command names; omitted for a credit or a zero obligation. format: uuid type: string depositDeadlineAt: description: Funding deadline (HrioLimDep on DtDep). format: date-time type: string id: description: Instruction id. format: uuid type: string lastFundingAck: $ref: "#/components/schemas/FundingAckResponse" description: The latest funding ack by STR instant; omitted until the first one lands. movementDate: description: Business (reference) date, YYYY-MM-DD. type: string numCtrlLdl: description: Câmara control number (NumCtrlLDL). type: string numCtrlStr: description: STR reserve-transfer control number; omitted until linked. type: string pendingBeyondTwoCycles: description: True when still non-terminal and at least two later same-product cycles have CLOSED (a chronology flag, not a position). type: boolean periodCode: description: Operating-period token inherited from the cycle. type: string product: description: Rail product; always OT. type: string receivedAt: description: Terminal funding-ack local ingest instant; omitted until terminal. format: date-time type: string side: description: Explicit money direction (never derived from the amount sign). enum: - DEBIT - CREDIT type: string sourceNuOp: description: LDL0021 BCMSG operation number (idempotency key). type: string state: description: Funding lifecycle state; a deposit the STR refused leaves it FUNDING_REQUIRED, a PAG0101 that puts this institution in status 2 or 8 closes an undeposited debit EXCLUDED, and a recálculo round closes an expected credit REPLACED. enum: - RECEIVED - FUNDING_REQUIRED - CREDIT_EXPECTED - SETTLED - EXCLUDED - REPLACED type: string terminalAt: description: Regulator-authoritative terminal instant; omitted until terminal. format: date-time type: string terminalSourceEventId: description: ce-id of the terminalising SPB fact; omitted until terminal. format: uuid type: string terminalTimestampRaw: description: Terminal timestamp raw wire form; omitted until terminal. type: string terminalTimestampSource: description: Terminal timestamp provenance tag; omitted until terminal. type: string traceabilityId: description: num_ctrl_if (siloc_ot_traceability); correlates to the STR reserve-transfer outcome. type: string required: - id - cycleId - sourceNuOp - product - movementDate - periodCode - state - side - amountRaw - amountCanonical - traceabilityId - numCtrlLdl - depositDeadlineAt - pendingBeyondTwoCycles - createdAt type: object SubmitScheduleQueryInputBody: additionalProperties: false properties: referenceDate: description: The date to ask about (DtRef), YYYY-MM-DD. format: date type: string scheduleType: description: P (padrão) or E (eventual). Omit to ask without constraining the type. Asking for E on a date with no eventual change is answered with the standard grid. enum: - P - E type: string required: - referenceDate type: object UpdateNotificationConfigInputBody: additionalProperties: false properties: channels: description: Channels to store; non-empty, unique, subset of {WEBHOOK, EMAIL}. items: type: string maxItems: 20 type: - array - "null" uniqueItems: true expectedVersion: description: The version last read; the update applies only while it still matches (optimistic lock). format: int64 minimum: 1 type: integer windowLeadMinutes: description: Lead time (minutes), 1-120. format: int64 maximum: 120 minimum: 1 type: integer required: - expectedVersion - windowLeadMinutes - channels type: object UpdateParticipantRequest: additionalProperties: false properties: name: description: New legal name (unchanged when omitted). maxLength: 200 type: string settlingInstitutionIspb: description: New settling institution ISPB (unchanged when omitted). pattern: ^[0-9]{8}$ type: string 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 Window: additionalProperties: false properties: depositCloses: type: string depositOpens: type: string recalculationAt: type: string sequence: format: int64 type: integer settlementAt: type: string required: - sequence - depositOpens - depositCloses - recalculationAt - settlementAt type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http info: description: OpenAPI 3.1 surface for Lerian SILOC, the participant-side rail connecting the institution to Núclea's SILOC deferred-net interbank settlement. title: Lerian SILOC API version: 1.0.0 openapi: 3.1.0 paths: /api/v1/siloc/advices: get: description: "Every message the SILOC câmara originated at this institution and this rail stored, newest movement date first. Narrow with codMsg to read one kind — the net result of negotiations (LDL0001), the events-and-emissions settlement forecast (LDL0007), a transfer request (LDL0010), a deposit request (LDL0013), a guarantee position to confirm (LDL1018), a collateral requirement met (LDL1026) or a movement outcome (LDL1027) — or with numCtrlLDL to find the one advice a confirmation answers. Projected verbatim (Catálogo de Serviços do SFN v5.13, Vol II): amounts are the câmara's own decimal strings, body carries that code's own fields exactly as they arrived, and nothing here nets, sums or confirms anything." operationId: listCamaraAdvices parameters: - description: Restrict to one advice code; omit for every code. explode: false in: query name: codMsg schema: description: Restrict to one advice code; omit for every code. enum: - LDL0001 - LDL0007 - LDL0010 - LDL0013 - LDL1018 - LDL1026 - LDL1027 type: string - description: Restrict to one câmara control number — the correlation key a confirmation leg echoes. explode: false in: query name: numCtrlLDL schema: description: Restrict to one câmara control number — the correlation key a confirmation leg echoes. type: string - description: Restrict to one business date (DtMovto), YYYY-MM-DD. explode: false in: query name: movementDate schema: description: Restrict to one business date (DtMovto), YYYY-MM-DD. format: date type: string - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/AdviceListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List the advices the SILOC câmara sent this institution tags: - Advice x-mint: href: /pt/reference/rails/siloc/list-camara-advices /api/v1/siloc/advices/transfer-credit-notices: get: description: The "Resposta a Terceiros" (R2) the PAG câmara sends the CREDITED institution of a fund transfer another institution requested — PAG0107R2, PAG0108R2, PAG0111R2, PAG0121R2, PAG0122R2, PAG0134R2, PAG0137R2, PAG0141R2, PAG0142R2, PAG0143R2 and PAG0151R2 (Catálogo de Serviços do SFN v5.13, Vol II) — keyset-paged newest posted first. Each notice is the câmara stating that a movement was POSTED in this institution's favour; it settles in the LDL cycle, and nothing here books, sums or settles it. The fields every notice carries are projected verbatim and rawBody holds the whole document as delivered. Narrow with movementDate, codMsg or numCtrlPAG. operationId: listPAGTransferCreditNotices parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer - description: Narrow to one movement date (DtMovto), YYYY-MM-DD. An unparsable value is refused, never dropped. explode: false in: query name: movementDate schema: description: Narrow to one movement date (DtMovto), YYYY-MM-DD. An unparsable value is refused, never dropped. format: date type: string - description: Narrow to one R2 code, e.g. PAG0107R2. explode: false in: query name: codMsg schema: description: Narrow to one R2 code, e.g. PAG0107R2. type: string - description: Narrow to one câmara control number. explode: false in: query name: numCtrlPAG schema: description: Narrow to one câmara control number. maxLength: 20 type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PAGCreditNoticeListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List the PAG transfer credit notices the câmara sent this institution tags: - Transfers x-mint: href: /pt/reference/rails/siloc/list-transfer-credit-notices /api/v1/siloc/alerts: get: description: The operational alerts, filtered by type and (by default) active only, keyset-paged newest first. A RECALCULATION alert carries its correlated cycle's active recálculo round complement window, read verbatim from ot_recalculations — never netted, summed, or recomputed. A connection-level alert (e.g. RELAY_DOWN) carries no cycle and no window. activeOnly=false includes deactivated alerts (history), which is where an acknowledged alarm goes. operationId: listAlerts parameters: - description: Filter by alert type. explode: false in: query name: type schema: description: Filter by alert type. enum: - WINDOW_CLOSING - RECALCULATION - RELAY_DOWN - CERTIFICATE_EXPIRY - CONNECTION_DOWN - SCHEDULE_CHANGE - CAMARA_INTERRUPTED - CAMARA_CLOSED - COLLATERAL_REQUIRED - COLLATERAL_SUBSTITUTION - ELIGIBLE_ASSETS_CHANGED - INBOUND_QUARANTINED - INBOUND_SEMANTIC_REJECTED - OUTBOUND_DISPATCHER_DOWN - UNANSWERED_REQUEST - OT_REPLAY_DOWN - XSD_VALIDATOR_DOWN - MULTILATERAL_RESULT_UNREADABLE - OT_CYCLE_NOT_SETTLED type: string - description: When true (default), returns only active (unresolved) alerts; false includes deactivated alerts (history). explode: false in: query name: activeOnly schema: default: true description: When true (default), returns only active (unresolved) alerts; false includes deactivated alerts (history). type: boolean - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/AlertListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List operational alerts tags: - Alerts x-mint: href: /pt/reference/rails/siloc/list-alerts /api/v1/siloc/alerts/{id}/acknowledge: post: description: "Records that an operator saw alert {id} and deactivates it, so it leaves the default (active-only) feed; it remains readable with activeOnly=false. The dismissal, its acknowledgement event and its audit row commit together. EVERY alert type is acknowledgeable, including the condition alarms (RELAY_DOWN, CONNECTION_DOWN, CERTIFICATE_EXPIRY, WINDOW_CLOSING): acknowledging asserts that a person saw the alarm, never that the condition ended, so while the condition holds the watcher's next poll raises a FRESH alert and it reappears. An unknown id is 404; an alert another operator already acknowledged (or that cleared itself) is 409, never a silent success. The response omits complementWindowClosesAt: the dismissal reads the alert row alone and performs no recálculo join." operationId: acknowledgeAlert parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string - description: Request correlation identifier. Generated when omitted. in: header name: X-Request-ID schema: description: Request correlation identifier. Generated when omitted. type: string - description: The alert to acknowledge. in: path name: id required: true schema: description: The alert to acknowledge. format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/AcknowledgeAlertInputBody" responses: "200": content: application/json: schema: $ref: "#/components/schemas/AlertResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Acknowledge an operational alert tags: - Alerts x-mint: href: /pt/reference/rails/siloc/acknowledge-an-operational-alert /api/v1/siloc/audit-records: get: description: "The append-only audit trail of privileged mutations (obligations, configuration changes, relayed messages, access), keyset-paged newest occurred first. Filterable by occurred_at range (from/to, inclusive), action type, and participant ISPB. Every field is a stored column projected verbatim — no counts, no aggregates, no derived durations. Read-only: the trail is never mutated through this surface." operationId: listAuditRecords parameters: - description: Inclusive lower bound on occurred_at (RFC 3339); omit for unbounded. explode: false in: query name: from schema: description: Inclusive lower bound on occurred_at (RFC 3339); omit for unbounded. format: date-time type: string - description: Inclusive upper bound on occurred_at (RFC 3339); omit for unbounded. explode: false in: query name: to schema: description: Inclusive upper bound on occurred_at (RFC 3339); omit for unbounded. format: date-time type: string - description: Filter by exact action type. explode: false in: query name: actionType schema: description: Filter by exact action type. type: string - description: Filter by exact participant ISPB (8 digits). explode: false in: query name: participantIspb schema: description: Filter by exact participant ISPB (8 digits). pattern: ^[0-9]{8}$ type: string - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/AuditRecordListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List audit records tags: - Audit x-mint: href: /pt/reference/rails/siloc/list-audit-records /api/v1/siloc/bilateral-balances: get: description: "The bilateral settlement balances the PAG câmara stated (PAG0200 — saldos bilaterais para liquidação de movimento de Prestador de Serviços de Compensação e de Liquidação), keyset-paged newest announced first. Every amount is the wire string the câmara sent: the stated multilateral amount, the stated payment and receipt totals, and the per-counterparty legs behind each. Read-only, and nothing here is computed — Lerian SILOC holds no position, nets no balance and does not reconcile the câmara's totals against its own legs. Acting on a statement is the client's ledger's business." operationId: listBilateralBalances parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer - description: "Narrow the feed to one settlement day (DtMovto), YYYY-MM-DD. An unparsable value is refused, never silently dropped: answering a question about one day with every day is not an answer." explode: false in: query name: movementDate schema: description: "Narrow the feed to one settlement day (DtMovto), YYYY-MM-DD. An unparsable value is refused, never silently dropped: answering a question about one day with every day is not an answer." format: date type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/BalanceListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List câmara bilateral settlement balances tags: - Bilateral x-mint: href: /pt/reference/rails/siloc/list-camara-bilateral-settlement-balances /api/v1/siloc/capabilities: get: description: Settlement-coverage transparency — the messages/flows the rail implements versus what SILOC defines. operationId: listCapabilities parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/CapabilityListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List settlement-coverage capabilities tags: - Integration x-mint: href: /pt/reference/rails/siloc/list-capabilities /api/v1/siloc/certificates: get: description: The certificate lifecycle view with expiry. The private key stays in the FI's custody and is never stored or accessed by the rail. operationId: listCertificates parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/CertificateListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List regulated certificates tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/list-certificates post: description: Registers the public certificate + custody reference for lifecycle tracking. The private key is never transmitted. A certificate whose authority and serial (sfnCertificateId) are already registered answers 409 with SILOC-0009. operationId: registerCertificate parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/RegisterCertificateRequest" required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/CertificateResponse" description: Created "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Register a certificate reference tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/register-certificate /api/v1/siloc/certificates/{certificateId}: get: operationId: getCertificate parameters: - description: Certificate id. in: path name: certificateId required: true schema: description: Certificate id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/CertificateResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get a certificate tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/get-certificate /api/v1/siloc/certificates/{certificateId}/revoke: post: description: Disables the running MQ credential before recording revocation. The request fails if runtime enforcement is unavailable. Repeated requests preserve the original revocation timestamp. operationId: revokeCertificate parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string - description: Certificate id. in: path name: certificateId required: true schema: description: Certificate id. format: uuid type: string - description: Request correlation identifier. Generated when omitted. in: header name: X-Request-ID schema: description: Request correlation identifier. Generated when omitted. type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/CertificateResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Revoke a certificate tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/revoke-certificate /api/v1/siloc/collateral/advisories: get: description: "The collateral advisories the câmara sent — LDL1001 (exigibilidade de colateral), LDL1011 (ativos a serem substituídos) and LDL1014 (alteração na lista de ativos elegíveis) — keyset-paged newest announced first, each projected verbatim including the amounts, deadlines and asset identifiers the câmara carried. Read-only: Lerian SILOC values no asset, computes no exposure and originates no deposit; acting on an advisory is a command an operator or the ledger consumer sends. Each arriving advisory also raises its operator alarm (COLLATERAL_REQUIRED, COLLATERAL_SUBSTITUTION, ELIGIBLE_ASSETS_CHANGED) on listAlerts and never affects readiness." operationId: listCollateralAdvisories parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer - description: Narrow the feed to one advisory code. explode: false in: query name: codMsg schema: description: Narrow the feed to one advisory code. enum: - LDL1001 - LDL1011 - LDL1014 type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/AdvisoryListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List câmara collateral advisories tags: - Collateral x-mint: href: /pt/reference/rails/siloc/list-camara-collateral-advisories /api/v1/siloc/cycles: get: description: A filterable, cursor-paginated page of the rail's own OT deferred-net cycles, newest first. operationId: listCycles parameters: - description: Filter by the cycle's business (reference) date. explode: false in: query name: referenceDate schema: description: Filter by the cycle's business (reference) date. format: date type: string - description: Filter by cycle status. explode: false in: query name: status schema: description: Filter by cycle status. enum: - OPEN - SETTLING - RECALCULATING - CLOSED type: string - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/CycleListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List OT settlement cycles tags: - Settlement x-mint: href: /pt/reference/rails/siloc/list-cycles /api/v1/siloc/cycles/{cycleId}: get: description: The cycle detail including the FI's net position (projected from the single correlated instruction, never a sum), windows, and settlement moment. operationId: getCycle parameters: - description: Cycle id. in: path name: cycleId required: true schema: description: Cycle id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/CycleResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get an OT settlement cycle tags: - Settlement x-mint: href: /pt/reference/rails/siloc/get-cycle /api/v1/siloc/cycles/{cycleId}/recalculations: get: description: The ordered Art.18 recálculo rounds for the cycle (oldest first), each projected verbatim — the excluded participant, the recomputed side + amount, the complement window (a later round surfaces the +15min prorrogation), and the internal resolution label — plus a note that any post-exclusion residual is a bilateral participant TED (surfacing, not routing). An unknown cycle is 404; a cycle that never entered recálculo is an empty chain. operationId: getCycleRecalculations parameters: - description: Cycle id. in: path name: cycleId required: true schema: description: Cycle id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/RecalculationChainResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get a cycle's recálculo round chain tags: - Settlement x-mint: href: /pt/reference/rails/siloc/get-cycle-recalculations /api/v1/siloc/cycles/{cycleId}/reconciliation: get: description: The reconciliation of the cycle's obligation against the SILOC câmara's newest GEN0015 multilateral result, with reason and any mismatch flagged. operationId: getCycleReconciliation parameters: - description: Cycle id. in: path name: cycleId required: true schema: description: Cycle id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ReconciliationResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get a cycle's reconciliation result tags: - Settlement x-mint: href: /pt/reference/rails/siloc/get-cycle-reconciliation /api/v1/siloc/dlq/deferred: get: description: "A cursor-paginated feed of inbound messages parked for semantic replay (OT_DEFERRED and STATUS_DEFERRED), newest first, optionally narrowed to one lifecycle status. status=SEMANTIC_REJECTED lists the messages this rail terminally REFUSED on their content — parked with zero business effect, never replayed — which is what the INBOUND_SEMANTIC_REJECTED alarm points at. Distinct from relay failures (awaiting replay) and from quarantined frames (refused past the backout threshold and parked off the queue). Read-only: a refused message is never re-fed, and the alarm is closed on the alert surface." operationId: listDeferredExceptions parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer - description: Narrow to one lifecycle status. Omitted returns every parked deferred message. explode: false in: query name: status schema: description: Narrow to one lifecycle status. Omitted returns every parked deferred message. enum: - PENDING - PROCESSING - RESOLVED - SEMANTIC_REJECTED type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeferredExceptionListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List parked deferred inbound messages tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/list-parked-deferred-inbound-messages /api/v1/siloc/dlq/quarantine: get: description: A cursor-paginated feed of inbound frames this rail refused past the configured backout threshold, parked in its own database and taken off the receive queue. Each entry carries the queue-manager evidence that identifies the frame. Distinct from relay failures, which are frames awaiting replay. operationId: listQuarantinedFrames parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/QuarantinedFrameListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List quarantined inbound frames tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/list-quarantined-inbound-frames /api/v1/siloc/dlq/quarantine/{id}/resolve: post: description: Acknowledges the quarantined frame {id} once an operator has dealt with it, and clears the INBOUND_QUARANTINED alert when no unresolved frame remains. It never re-feeds the frame. An unknown, already-resolved or non-quarantine id is a 404. operationId: resolveQuarantinedFrame parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string - description: Request correlation identifier. Generated when omitted. in: header name: X-Request-ID schema: description: Request correlation identifier. Generated when omitted. type: string - description: The quarantined-frame id to resolve. in: path name: id required: true schema: description: The quarantined-frame id to resolve. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/QuarantineResolveResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Resolve a quarantined inbound frame tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/resolve-a-quarantined-inbound-frame /api/v1/siloc/dlq/relay-failures: get: description: A cursor-paginated feed of funding frames parked (RELAY_FAILED) during a sustained relay outage, awaiting administrative replay. Distinct from QM-quarantined poison frames. operationId: listRelayFailures parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/RelayFailureListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List parked relay failures tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/list-relay-failures /api/v1/siloc/dlq/relay-failures/{id}/replay: post: description: Re-relays the parked funding frame {id} to Lerian SLC once the relay has recovered. Idempotent via the inbound dedup ledger; an unknown or already-resolved id is a 404. operationId: replayRelayFailure parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string - description: The parked-frame id to replay. in: path name: id required: true schema: description: The parked-frame id to replay. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/RelayReplayResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Replay a parked relay failure tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/replay-relay-failure /api/v1/siloc/file-notices: get: description: "The GEN0015 notices other SFN participants sent this institution to say a file is available — answering a GEN0014 request, or announcing the file unprompted — keyset-paged newest announced first, each projected verbatim. Unlike every other arriving message on this rail, the sender is another participant rather than the câmara, so it is carried on each row and verified against the certificate that sent the frame. Read-only, and the notice half only: Lerian SILOC records that a file was announced and publishes the fact; fetching the file is a consumer's decision and a separate leg." operationId: listFileNotices parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer - description: "Narrow the feed to one announcing participant's ISPB. Grammar only: this rail keeps no roster of legitimate announcers, because GEN0015 is participant-to-participant." explode: false in: query name: ispbEmissor schema: description: "Narrow the feed to one announcing participant's ISPB. Grammar only: this rail keeps no roster of legitimate announcers, because GEN0015 is participant-to-participant." pattern: ^[0-9A-Z]{8}$ type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/NoticeListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List file-availability notices from other participants tags: - FileTransfer x-mint: href: /pt/reference/rails/siloc/list-file-notices /api/v1/siloc/homologation/scenarios: get: description: The operator's certification scenarios with per-scenario status, objective, expected input, and pass criterion, in certification order. Each scenario's status is the status of its latest run. operationId: listHomologationScenarios parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/HomologationScenarioListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List homologation scenarios tags: - Onboarding x-mint: href: /pt/reference/rails/siloc/list-homologation-scenarios /api/v1/siloc/homologation/scenarios/{scenarioId}: get: description: "One certification scenario: its objective, expected input, pass criterion, the status of its latest run, and when it last ran." operationId: getHomologationScenario parameters: - description: The scenario id. in: path name: scenarioId required: true schema: description: The scenario id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/HomologationScenarioResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get a homologation scenario tags: - Onboarding x-mint: href: /pt/reference/rails/siloc/get-a-homologation-scenario /api/v1/siloc/homologation/scenarios/{scenarioId}/runs: get: description: "The scenario's recorded certification history, newest first: every run with its outcome, its start and finish instants, and its evidence document. This is where the evidence of a run outlives the request that created it — a reload, a second operator, and an exported history all read it here. Runs whose lease expired before an outcome was recorded appear as FAILED carrying their abandoned evidence; hiding them would make the history lie about what happened." operationId: listHomologationScenarioRuns parameters: - description: The scenario whose runs to list. in: path name: scenarioId required: true schema: description: The scenario whose runs to list. format: uuid type: string - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/HomologationRunListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List a homologation scenario's runs tags: - Onboarding x-mint: href: /pt/reference/rails/siloc/list-a-homologation-scenario-s-runs post: description: Evaluates the scenario's pass criterion against the rail's own persisted state and readiness — the registered local certificate and trust store, the relayed-message ledger, the settlement cycles — and records the run with its evidence document. Nothing is injected onto the wire. A criterion that does not hold, and a criterion whose underlying state could not be read, both record a FAILED run carrying the reason; neither is reported as passing. A scenario with a run already in progress is a 409. Run history persists and is exportable. operationId: runHomologationScenario parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string - description: The scenario to run. in: path name: scenarioId required: true schema: description: The scenario to run. format: uuid type: string responses: "201": content: application/json: schema: $ref: "#/components/schemas/HomologationRunResponse" description: Created "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Run a homologation scenario tags: - Onboarding x-mint: href: /pt/reference/rails/siloc/run-a-homologation-scenario /api/v1/siloc/notifications/config: get: description: The singleton notification configuration and its optimistic-concurrency version. operationId: getNotificationConfig responses: "200": content: application/json: schema: $ref: "#/components/schemas/NotificationConfigResponse" description: OK "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 security: - BearerAuth: [] summary: Get notification configuration tags: - Integration x-mint: href: /pt/reference/rails/siloc/get-notification-config put: description: Replaces the notification configuration under optimistic locking; the update applies only if expectedVersion still matches the stored version (else 409). operationId: updateNotificationConfig parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNotificationConfigInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/NotificationConfigResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Update notification configuration tags: - Integration x-mint: href: /pt/reference/rails/siloc/update-notification-config /api/v1/siloc/ot-multilateral-results: get: description: "The conciliation file the SILOC câmara attaches to a GEN0015 at each deposit-period opening (OP082 §10.2 ): this institution's multilateral net, the position consolidated per counterparty and the net per product with its bilateral legs, keyset-paged newest first and projected verbatim. A GEN0015 whose USERMSG is not a readable result stores its notice and raises MULTILATERAL_RESULT_UNREADABLE instead. Read-only: Lerian SILOC states the câmara's result and never sums or nets it." operationId: listOTMultilateralResults parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/MultilateralResultListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List the SILOC câmara's official multilateral results tags: - FileTransfer x-mint: href: /pt/reference/rails/siloc/list-the-siloc-camaras-official-multilateral-results /api/v1/siloc/outbound/barcode-document-settlements: post: description: Issues a PAG0122 "IF requisita Transferência de recursos para liquidação de documentos com código de barras" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds to settle a document carrying a barcode, naming the drawee, the assignor, the payment channel and the amount breakdown the collection carried. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0122R1) arrives asynchronously and is read back with getPAG0122. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0122 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0122Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0122Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds to settle a barcoded document tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-funds-to-settle-a-barcoded-document /api/v1/siloc/outbound/barcode-document-settlements/{id}: get: description: "The stored PAG0122 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0122E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0122 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0122Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0122 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0122-instruction-and-its-answer /api/v1/siloc/outbound/camara-withdrawals: post: description: "Issues an LDL0032 \"IF requisita saque parcial ou total na Câmara\" to the Câmara LDL (Catálogo de Serviços do SFN v5.13, Vol II). It asks the câmara to return part or all of this institution's net balance from the Conta de Liquidação to its Reservas Bancárias or settlement account at the Bacen. TpDev chooses which amount: TOT (everything the participant may withdraw), LIM (at most VlrLimDev) or VAL (exactly VlrLimDev) — LIM and VAL require VlrLimDev, and a request carrying either without it is refused here rather than signed. The câmara determines the maximum it will return, so this rail neither computes nor bounds the amount. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL0032R1) arrives asynchronously and is read back with getLDL0032. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitLDL0032 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL0032Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlIFCommandBodyLDL0032Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Withdraw balance from the settlement account tags: - Settlement x-mint: href: /pt/reference/rails/siloc/withdraw-balance-from-the-settlement-account /api/v1/siloc/outbound/camara-withdrawals/{id}: get: description: "The stored LDL0032 request projected verbatim, its dispatch state, and — once the câmara has answered — its answer. The answer's details object carries NumCtrlLDL (the câmara's own control number for the movement), SitLancDev and, when present, VlrLanc. SitLancDev is projected VERBATIM and never decoded: its seventeen values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getLDL0032 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlIFCommandBodyLDL0032Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL0032 command and its answer tags: - Settlement x-mint: href: /pt/reference/rails/siloc/read-one-ldl0032-command-and-its-answer /api/v1/siloc/outbound/card-commands: get: description: "Every command received on the card route, newest first, with the outcome the câmara returned. It is the operator half of the card-route alarm: a stalled consumer, a câmara that stopped answering and a broker that went quiet all look the same from outside, and this is where the commands stuck in RECEIVED or ACCEPTED become visible. Readiness is deliberately not the signal — a stalled feed alarms, it does not take the rail out of rotation." operationId: listCardCommands parameters: - description: Narrow to one lifecycle state. Omit for every command. explode: false in: query name: status schema: description: Narrow to one lifecycle state. Omit for every command. enum: - RECEIVED - ACCEPTED - ANSWERED - REFUSED - FAILED type: string - description: Maximum commands to return. explode: false in: query name: limit schema: default: 50 description: Maximum commands to return. format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListCardCommandsOutputBody" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List the card-route commands Lerian SLC issued tags: - Card route x-mint: href: /pt/reference/rails/siloc/list-the-card-route-commands-lerian-slc-issued /api/v1/siloc/outbound/card-commands/{id}: get: description: One command Lerian SLC issued, the message it produced, and — for an answered position query — every entry the câmara returned, verbatim. operationId: getCardCommand parameters: - description: Command id. in: path name: id required: true schema: description: Command id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/CardCommandResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one card-route command tags: - Card route x-mint: href: /pt/reference/rails/siloc/read-one-card-route-command /api/v1/siloc/outbound/client-account-transfers: post: description: Issues a PAG0108 "IF requisita Transferência de recursos entre contas de clientes" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds between natural or legal persons holding accounts at different financial institutions. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0108R1) arrives asynchronously and is read back with getPAG0108. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0108 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0108Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0108Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds between client accounts tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-funds-between-client-accounts /api/v1/siloc/outbound/client-account-transfers/{id}: get: description: "The stored PAG0108 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0108E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0108 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0108Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0108 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0108-instruction-and-its-answer /api/v1/siloc/outbound/collateral-movements: post: description: "Issues a LDL1016 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of collateral or securities between holders, sub-holders or cover purposes within one Entidade Responsável (Vol II, Evento LDL1016 Descrição). RLDL0012: Número Controle LDL Original names the control number of the LDL1001 that required the collateral. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1016R1) arrives asynchronously and is read back with getLDL1016. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitLDL1016 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1016Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1016Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Move collateral between holders or purposes tags: - Collateral x-mint: href: /pt/reference/rails/siloc/move-collateral-between-holders-or-purposes /api/v1/siloc/outbound/collateral-movements/{id}: get: description: "The stored LDL1016 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1016E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1016 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1016Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1016 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1016-request-and-its-answer /api/v1/siloc/outbound/deposit-acceptance-requests: post: description: "Issues a LDL1002 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Requests the câmara's acceptance of a deposit — voluntary or required — of guarantee, margin or securities, for one or more assets under a named holder (Vol II, Evento LDL1002 Descrição). The aceite the câmara grants here is what LDL1003 later draws on: its answer carries a Número Controle Aceite LDL per asset, and the deposit request names it back. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1002R1) arrives asynchronously and is read back with getLDL1002. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitLDL1002 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1002Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1002Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Ask the câmara to accept a collateral deposit tags: - Collateral x-mint: href: /pt/reference/rails/siloc/ask-the-camara-to-accept-a-collateral-deposit /api/v1/siloc/outbound/deposit-acceptance-requests/{id}: get: description: "The stored LDL1002 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1002E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1002 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1002Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1002 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1002-request-and-its-answer /api/v1/siloc/outbound/deposit-requests: post: description: "Issues a LDL1003 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Requests the deposit itself, for assets the câmara already accepted through LDL1002; each asset names the original Número Controle Requisição IF and Número Controle Aceite LDL (Vol II, Evento LDL1003 Descrição). RLDL0008: one custody transfer that produces several allocations repeats its Selic or CETIP operation number once per Entidade Responsável 2. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1003R1) arrives asynchronously and is read back with getLDL1003. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitLDL1003 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1003Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1003Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Request a collateral deposit the câmara already accepted tags: - Collateral x-mint: href: /pt/reference/rails/siloc/request-collateral-deposit /api/v1/siloc/outbound/deposit-requests/{id}: get: description: "The stored LDL1003 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1003E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1003 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1003Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1003 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1003-request-and-its-answer /api/v1/siloc/outbound/deposited-asset-queries: post: description: Issues a LDL1012 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Asks the câmara which assets are deposited for a named holder and sub-holder, with the totals it holds against them (Vol II, Evento LDL1012 Descrição). Only assets deposited for the Titular and Subtitular named in the request come back (Evento LDL1012 Observação), so a query that names the wrong holder answers empty rather than failing. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1012R1) arrives asynchronously and is read back with getLDL1012. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. operationId: submitLDL1012 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1012Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1012Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Query the assets deposited at the câmara tags: - Collateral x-mint: href: /pt/reference/rails/siloc/query-the-assets-deposited-at-the-camara /api/v1/siloc/outbound/deposited-asset-queries/{id}: get: description: "The stored LDL1012 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1012E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1012 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1012Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1012 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1012-request-and-its-answer /api/v1/siloc/outbound/eligible-collateral-queries: post: description: Issues a LDL1013 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Asks which assets the Câmara LDL accepts as collateral and at what prices (Vol II, Evento LDL1013 Descrição). Its answer carries a price per settlement-term indicator, which is what makes it a different question from LDL1015's price history for one asset on one day. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1013R1) arrives asynchronously and is read back with getLDL1013. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. operationId: submitLDL1013 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1013Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1013Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Query the assets the câmara accepts as collateral tags: - Collateral x-mint: href: /pt/reference/rails/siloc/query-the-assets-the-camara-accepts-as-collateral /api/v1/siloc/outbound/eligible-collateral-queries/{id}: get: description: "The stored LDL1013 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1013E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1013 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1013Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1013 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1013-request-and-its-answer /api/v1/siloc/outbound/entry-queries: post: description: Issues a PAG0113 "IF consulta Lançamentos na Câmara PAG" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Asks the câmara which entries it holds for this institution on a movement date. Every optional field in the body is a FILTER that narrows the universe returned (RSTR0007); supplying none asks for all of them. ⚠️ The answer NEVER includes a message the câmara refused for a format or basic-consistency error (RPAG0004), so an empty result means "no entry matches these filters" and never "nothing was sent". The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0113R1) arrives asynchronously and is read back with getPAG0113. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. operationId: submitPAG0113 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0113Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0113Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Query the entries the Câmara PAG holds tags: - Câmara control x-mint: href: /pt/reference/rails/siloc/query-the-entries-the-camara-pag-holds /api/v1/siloc/outbound/entry-queries/{id}: get: description: The stored PAG0113 request projected verbatim, its dispatch state, and — once the câmara has answered — what it replied, also verbatim. The answer carries up to 200 entries, in the order the câmara sent them, each with its amount as the decimal STRING the câmara wrote. `entries` is always present and is the empty list when the query matched nothing. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0113E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). operationId: getPAG0113 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0113Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0113 instruction and its answer tags: - Câmara control x-mint: href: /pt/reference/rails/siloc/read-one-pag0113-instruction-and-its-answer /api/v1/siloc/outbound/guarantee-issuance-confirmations: post: description: "Issues an LDL1019 \"IF informa Confirmação de emissão ou aditamento de fiança\" to the Câmara LDL (Catálogo de Serviços do SFN v5.13, Vol II). It confirms, or rejects, the guarantee position the câmara announced on its LDL1018: SitConfc is S (Sim) or N (Não), and NumCtrlLDLOr is filled with the Número Controle LDL that LDL1018 carried (RLDL0013). Both are the operator's to supply, because the câmara sent them and this rail derives no reply of its own. The command is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo. THE CATÁLOGO REGISTERS NO POSITIVE ANSWER LEG FOR THIS MESSAGE, so an accepted confirmation stays DISPATCHED and only a refusal (LDL1019E) moves it again. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitLDL1019 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1019Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlIFCommandBodyLDL1019Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Confirm a guarantee issuance or amendment tags: - Collateral x-mint: href: /pt/reference/rails/siloc/confirm-a-guarantee-issuance-or-amendment /api/v1/siloc/outbound/guarantee-issuance-confirmations/{id}: get: description: "The stored LDL1019 request projected verbatim and its dispatch state. There is no answer block on this code and there never will be: the Catálogo registers no LDL1019R1, and the official LDL1019.XSD declares none. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue — the terminal state for an accepted confirmation, because no reply is owed), REFUSED (the câmara returned the LDL1019E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it)." operationId: getLDL1019 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlIFCommandBodyLDL1019Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1019 command and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1019-command-and-its-answer /api/v1/siloc/outbound/guarantee-maturity-amendments: post: description: "Issues a LDL1010 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Requests an amendment to the maturity date or the amount of a fiança already deposited as collateral (Vol II, Evento LDL1010 Descrição). The answer is a single S/N situação (SitAditt, official type Indr): the câmara either took the amendment or did not. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1010R1) arrives asynchronously and is read back with getLDL1010. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitLDL1010 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1010Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1010Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Ask to amend a guarantee's maturity or amount tags: - Collateral x-mint: href: /pt/reference/rails/siloc/ask-to-amend-a-guarantee-s-maturity-or-amount /api/v1/siloc/outbound/guarantee-maturity-amendments/{id}: get: description: "The stored LDL1010 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1010E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1010 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1010Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1010 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1010-request-and-its-answer /api/v1/siloc/outbound/inoperative-status-changes: post: description: "Issues a PAG0201 \"IF requisita alteração de situação para inoperante\" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Asks the câmara to make this participant INOPERANTE from a stated date, which makes the exchange of messages with it impossible. ⛔ THIS IS THE STOP SWITCH FOR THIS PARTICIPANT ON THE PAG CÂMARA: nothing this rail sends afterwards reaches the câmara until a PAG0202 puts it back. The câmara requires the date of the change to differ from the current date (RPAG0007) and enforces that itself. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0201R1) arrives asynchronously and is read back with getPAG0201. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitPAG0201 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0201Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0201Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Request this participant to become inoperante tags: - Participant situação x-mint: href: /pt/reference/rails/siloc/request-this-participant-to-become-inoperante /api/v1/siloc/outbound/inoperative-status-changes/{id}: get: description: The stored PAG0201 request projected verbatim, its dispatch state, and — once the câmara has answered — what it replied, also verbatim. The answer carries the câmara's own control number for the change it registered — the value a PAG0203 names to withdraw it. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0201E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). operationId: getPAG0201 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0201Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0201 instruction and its answer tags: - Participant situação x-mint: href: /pt/reference/rails/siloc/read-one-pag0201-instruction-and-its-answer /api/v1/siloc/outbound/judicial-deposit-transfers: post: description: Issues a PAG0121 "IF requisita Transferência de recursos para depósito judicial" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds between financial institutions for a federal, state or labour judicial deposit, and for the judicial and extrajudicial deposits of Lei 9703/98 where the credited institution has pre-registered the depositor. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0121R1) arrives asynchronously and is read back with getPAG0121. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0121 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0121Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0121Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds for a judicial deposit tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-funds-for-a-judicial-deposit /api/v1/siloc/outbound/judicial-deposit-transfers/{id}: get: description: "The stored PAG0121 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0121E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0121 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0121Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0121 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0121-instruction-and-its-answer /api/v1/siloc/outbound/judicial-release-transfers: post: description: Issues a PAG0151 "IF requisita transferência de recursos para liberação de recursos judiciais" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds releasing judicial deposits, naming the court, the case number and the parties. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0151R1) arrives asynchronously and is read back with getPAG0151. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0151 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0151Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0151Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds for a judicial release tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-funds-for-a-judicial-release /api/v1/siloc/outbound/judicial-release-transfers/{id}: get: description: "The stored PAG0151 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0151E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0151 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0151Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0151 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0151-instruction-and-its-answer /api/v1/siloc/outbound/ltr-nonliquidante-decisions: post: description: "Issues an LTR0008 \"IF informa Confirmação ou rejeição de liquidação entre Não Liquidantes\" to the câmara (Catálogo de Serviços do SFN v5.13, Vol II), answering the LTR0007 it announced. Returns 202; the answer (LTR0008R1) arrives asynchronously. When the LBTR cycle of the movementDate it carries is closed (from 17h30 Brasília or the later LBTR close an operator recorded for that day at recordScheduleChange, or all day on a non-business day), it answers 422 with SILOC-0025 and stores nothing; a movementDate later than today's in Brasília answers no announced LTR0007 and is refused 422 with SILOC-0022. An operation whose earlier answer is SUBMITTED, DISPATCHED or ANSWERED takes no second one: 409 with SILOC-0026, nothing stored; after that answer FAILED or was REFUSED a new one is accepted." operationId: submitLTRNonLiquidanteDecision parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/NonLiquidanteDecisionInputBody" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/CardMessageResponse" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Confirm or reject a settlement between two non-settling members tags: - Card route x-mint: href: /pt/reference/rails/siloc/decide-non-settling-member-settlement /api/v1/siloc/outbound/ltr-nonliquidante-decisions/{id}: get: description: The stored LTR0008 request, its dispatch state and, once ANSWERED, the câmara's LTR0008R1 body — all projected verbatim. An ANSWERED decision whose body this rail does not hold says so in answerAbsent; it never renders as an empty answer. operationId: getLTRNonLiquidanteDecision parameters: - description: Message id. in: path name: id required: true schema: description: Message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/CardMessageResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LTR0008 decision and its state tags: - Card route x-mint: href: /pt/reference/rails/siloc/read-one-ltr0008-decision-and-its-state /api/v1/siloc/outbound/ltr-position-queries: post: description: "Issues an LTR0009 \"IF consulta Posição financeira\" to the câmara (Catálogo de Serviços do SFN v5.13, Vol II). Every field but movementDate is an optional filter: omit one to leave that dimension unconstrained. Returns 202; the answer (LTR0009R1) carries up to 200 position entries and is projected verbatim — this rail never sums, nets or rounds them." operationId: submitLTRPositionQuery parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PositionQueryInputBody" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/CardMessageResponse" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Ask the câmara for the institution's LBTR position tags: - Card route x-mint: href: /pt/reference/rails/siloc/ask-the-camara-for-the-institution-s-lbtr-position /api/v1/siloc/outbound/ltr-position-queries/{id}: get: description: The stored LTR0009 request, its dispatch state and, once ANSWERED, the câmara's LTR0009R1 body — all projected verbatim. An ANSWERED query whose body this rail does not hold says so in answerAbsent; it never renders as an empty answer. operationId: getLTRPositionQuery parameters: - description: Message id. in: path name: id required: true schema: description: Message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/CardMessageResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LTR0009 query and its state tags: - Card route x-mint: href: /pt/reference/rails/siloc/read-one-ltr0009-query-and-its-state /api/v1/siloc/outbound/ltr-result-decisions: post: description: "Issues an LTR0002 \"IF informa Resultado da negociação confirmado ou divergente\" to the câmara (Catálogo de Serviços do SFN v5.13, Vol II), answering the LTR0001 it announced. The request is minted, built, signed, encrypted and durably recorded before anything reaches the queue: this returns 202 with the control number the câmara will echo, and the answer (LTR0002R1) arrives asynchronously. tpConfDivg is C (Confirma) or D (Diverge), the BACEN Dicionário de Domínios TpConfDivg values. When the LBTR cycle of the movementDate it carries is closed (from 17h30 Brasília or the later LBTR close an operator recorded for that day at recordScheduleChange, or all day on a non-business day), it answers 422 with SILOC-0025 and stores nothing; a movementDate later than today's in Brasília answers no announced LTR0001 and is refused 422 with SILOC-0022. An operation whose earlier answer is SUBMITTED, DISPATCHED or ANSWERED takes no second one: 409 with SILOC-0026, nothing stored; after that answer FAILED or was REFUSED a new one is accepted, and an answered confirmation (C) still takes a divergence (D)." operationId: submitLTRResultDecision parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ResultDecisionInputBody" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/CardMessageResponse" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Confirm or diverge from an announced LBTR result tags: - Card route x-mint: href: /pt/reference/rails/siloc/confirm-or-diverge-from-an-announced-lbtr-result /api/v1/siloc/outbound/ltr-result-decisions/{id}: get: description: The stored LTR0002 request, its dispatch state and, once ANSWERED, the câmara's LTR0002R1 body — all projected verbatim. An ANSWERED decision whose body this rail does not hold says so in answerAbsent; it never renders as an empty answer. operationId: getLTRResultDecision parameters: - description: Message id. in: path name: id required: true schema: description: Message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/CardMessageResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LTR0002 decision and its state tags: - Card route x-mint: href: /pt/reference/rails/siloc/read-one-ltr0002-decision-and-its-state /api/v1/siloc/outbound/messages: get: description: "Every message this institution has issued to the câmara, newest first, whatever its code. Narrow with status to work a backlog: FAILED is the set the rail will never deliver as stored and an operator has to act on, REFUSED the set the câmara received and returned as its E twin, and this list is the only way to see a message whose code this build does not recognise. The projection is the columns every SFN request carries; the stored request is not interpreted here, so read a code's own operation for its own fields." operationId: listOutboundMessages parameters: - description: Narrow to one lifecycle state; omit for every message. explode: false in: query name: status schema: description: Narrow to one lifecycle state; omit for every message. enum: - SUBMITTED - DISPATCHED - ANSWERED - REFUSED - FAILED type: string - description: Only the messages held for an answer the câmara never sent, whatever their age; takes the place of status. explode: false in: query name: held schema: description: Only the messages held for an answer the câmara never sent, whatever their age; takes the place of status. type: boolean - description: Page size, at most 200. Defaults to 50. explode: false in: query name: limit schema: description: Page size, at most 200. Defaults to 50. format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/OutboundMessageListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List outbound messages of every code tags: - Schedule x-mint: href: /pt/reference/rails/siloc/list-outbound-messages-of-every-code /api/v1/siloc/outbound/messages/{id}: get: description: "The universal state of one issued message: its code, the control number the câmara echoes, its lifecycle status, how many queue puts have been attempted and why the last one failed. The stored request is not interpreted here." operationId: getOutboundMessage parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/OutboundMessageResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one outbound message, whatever its code tags: - Schedule x-mint: href: /pt/reference/rails/siloc/read-one-outbound-message-whatever-its-code /api/v1/siloc/outbound/messages/{id}/close-request: post: description: "A message whose time ran out after a put whose outcome is unknown stays SUBMITTED, held for an answer the câmara may never send, and the rail never fails it alone. Records this operator's request, with the evidence in reason, to close it as failed. Nothing changes until a second, different operator approves. 403 for a machine credential: the close is for people. A câmara answer parked for the message blocks the plain close, since it may say the message settled. When the rail refused that answer on content (it never replays; see the DLQ status SEMANTIC_REJECTED), the operator reads it and declares the outcome it states by passing its id in parkedAnswerId: outcome FAILED for the message's E twin (the approval ends the send REFUSED and emits the refusal fact), outcome SETTLED with settledAt for the R1 of an LTR0002 or LTR0008 (the approval ends it ANSWERED and emits the answered fact the câmara's own answer would have). For the R1 of a PAG transfer the operator also types numCtrl (NumCtrlPAG) and situation (SitLancPAG), read in the answer, and settledAt is its DtHrSit; the second operator types the same values to approve, and the answered fact carries declaredByOperators. The other R1 legs (queries, lists and the LDL answers) cannot be declared. 409 when the message is not held, a request already awaits its approval, an answer that can still replay is parked, or parkedAnswerId does not name a refused answer of this message that states the declared outcome. 422 when outcome, settledAt, numCtrl or situation is missing, misplaced, outside the answer's official facets or (settledAt) in the future." operationId: requestOutboundMessageClose parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CloseRequestInputBody" required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/OutboundCloseRequestResponse" description: Created "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Ask to close a held outbound message, or to declare its outcome tags: - Schedule x-mint: href: /pt/reference/rails/siloc/ask-to-close-a-held-outbound-message-or-to-declare-its-outcome /api/v1/siloc/outbound/messages/{id}/close-request/approve: post: description: "The second operator's step: ends the message FAILED (or as declared), writes its fact for the client's ledger, closes the card command behind it and records both operators in the audit trail, in one transaction. A declaration with typed values (numCtrl, situation) is approved only with the same values and settledAt in the body (422 otherwise, the request stays pending). 403 for the operator who made the request and for a machine credential; 409 when no request awaits approval, or when the câmara's answer reached the message first (the request is then closed as superseded and the message stays as the answer left it)." operationId: approveOutboundMessageClose parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ApproveCloseInputBody" responses: "200": content: application/json: schema: $ref: "#/components/schemas/OutboundCloseRequestResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Approve the close of a held outbound message as failed tags: - Schedule x-mint: href: /pt/reference/rails/siloc/approve-the-close-of-a-held-outbound-message-as-failed /api/v1/siloc/outbound/net-position-queries: post: description: Issues an LDL0026 "IF consulta Posição de resultado líquido de negociação" to the Câmara LDL (Catálogo de Serviços do SFN v5.13, Vol II). It asks for this institution's net result for a settlement date, or the remaining balance of partial payments, for itself and for its non-settling members. It moves no money. The query is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL0026R1) arrives asynchronously and is read back with getLDL0026. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. operationId: submitLDL0026 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL0026Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlIFCommandBodyLDL0026Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Ask the câmara for the net position tags: - Settlement x-mint: href: /pt/reference/rails/siloc/ask-the-camara-for-the-net-position /api/v1/siloc/outbound/net-position-queries/{id}: get: description: "The stored LDL0026 request projected verbatim, its dispatch state, and — once the câmara has answered — its answer. The answer's details object carries TpInf, DtLiquid and Grupo_LDL0026R1_ResultLiqd, the per-non-settling-member results, ALWAYS as an array even when the câmara sent one repetition. Every value is projected exactly as written and never decoded: TpInf's values are published in BACEN's separate Dicionário de Domínios with their own activation and deactivation dates, so what one means is the ledger consumer's call." operationId: getLDL0026 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlIFCommandBodyLDL0026Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL0026 command and its answer tags: - Settlement x-mint: href: /pt/reference/rails/siloc/read-one-ldl0026-command-and-its-answer /api/v1/siloc/outbound/net-result-confirmations: post: description: "Issues an LDL0003 \"IF informa Resultado líquido de negociações confirmado ou divergente\" to the Câmara LDL (Catálogo de Serviços do SFN v5.13, Vol II). It states which of the lançamentos the câmara announced on its LDL0001 this institution accepts, and at what value: a lançamento accepted in part is reported at the value actually recognised, one NOT accepted is reported as ZERO, and one accepted in full at its original value. NumCtrlLDLOr names the LDL0001 being confirmed and is the operator's to supply, because the câmara sent it and this rail derives no reply of its own. The command is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL0003R1) arrives asynchronously and is read back with getLDL0003. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitLDL0003 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL0003Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlIFCommandBodyLDL0003Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Confirm or dispute the day's net result tags: - Settlement x-mint: href: /pt/reference/rails/siloc/confirm-or-dispute-the-day-s-net-result /api/v1/siloc/outbound/net-result-confirmations/{id}: get: description: The stored LDL0003 request projected verbatim, its dispatch state, and — once the câmara has acknowledged — the answer it sent. LDL0003R1 is an acknowledgement and carries no body beyond the header, so its details object is empty. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL0003E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). operationId: getLDL0003 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlIFCommandBodyLDL0003Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL0003 command and its answer tags: - Settlement x-mint: href: /pt/reference/rails/siloc/read-one-ldl0003-command-and-its-answer /api/v1/siloc/outbound/non-account-holder-transfers: post: description: Issues a PAG0107 "IF requisita Transferência de recursos por conta de não-correntistas" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds on behalf of a party that holds no account at this institution, for credit to a client or non-account-holder account at another one. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0107R1) arrives asynchronously and is read back with getPAG0107. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0107 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0107Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0107Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds on behalf of a non-account holder tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-funds-on-behalf-of-a-non-account-holder /api/v1/siloc/outbound/non-account-holder-transfers/{id}: get: description: "The stored PAG0107 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0107E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0107 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0107Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0107 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0107-instruction-and-its-answer /api/v1/siloc/outbound/non-reserve-institution-transfers: post: description: Issues a PAG0134 "IF requisita Transferência de recursos envolvendo conta de cliente em instituição não-detentora de conta Reservas Bancárias ou de liquidação" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds involving a client account at an institution that holds neither a Reservas Bancárias nor a settlement account, naming the investor the movement is on behalf of. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0134R1) arrives asynchronously and is read back with getPAG0134. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0134 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0134Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0134Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds for a client at a non-reserve-holding institution tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-to-non-reserve-institution /api/v1/siloc/outbound/non-reserve-institution-transfers/{id}: get: description: "The stored PAG0134 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0134E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0134 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0134Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0134 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0134-instruction-and-its-answer /api/v1/siloc/outbound/operative-status-changes: post: description: Issues a PAG0202 "IF requisita alteração de situação para operante" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Asks the câmara to put this participant back to OPERANTE, making the exchange of messages possible again. The layout carries no date of its own. ⚠️ The change takes effect in D+1 and is accepted ONLY while the participant is inoperante (the Catálogo's own Observação), so a REFUSED row here most often means the participant was already operante. Both conditions are the câmara's and the câmara enforces them. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0202R1) arrives asynchronously and is read back with getPAG0202. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0202 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0202Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0202Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Request this participant to become operante tags: - Participant situação x-mint: href: /pt/reference/rails/siloc/request-this-participant-to-become-operante /api/v1/siloc/outbound/operative-status-changes/{id}: get: description: The stored PAG0202 request projected verbatim, its dispatch state, and — once the câmara has answered — what it replied, also verbatim. The answer carries the câmara's own control number for the change it registered — the value a PAG0203 names to withdraw it. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0202E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). operationId: getPAG0202 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0202Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0202 instruction and its answer tags: - Participant situação x-mint: href: /pt/reference/rails/siloc/read-one-pag0202-instruction-and-its-answer /api/v1/siloc/outbound/payroll-loan-credit-transfers: post: description: Issues a PAG0141 "IF requisita Transferência de recursos para crédito de consignação em IF detentora de relacionamento com aposentado" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds crediting a payroll loan where the pensioner receives the INSS benefit at another institution, by INSS card or account credit. It carries the benefit number, the loan contract, the INSS endorsement protocol and the fee the credited bank retains. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0141R1) arrives asynchronously and is read back with getPAG0141. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0141 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0141Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0141Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds for a payroll-loan credit tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-funds-for-a-payroll-loan-credit /api/v1/siloc/outbound/payroll-loan-credit-transfers/{id}: get: description: "The stored PAG0141 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0141E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0141 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0141Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0141 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0141-instruction-and-its-answer /api/v1/siloc/outbound/pending-entry-cancellations: post: description: "Issues a PAG0112 \"IF requisita Cancelamento de lançamento pendente na Câmara PAG\" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Cancels a transfer already registered in the câmara that is still sitting in the pending queue, naming it by the câmara's own control number (NumCtrlPAGOr). ⚠️ A lançamento the câmara has already finalised CANNOT be cancelled: the Catálogo's own Observação says the message returns an error, so a REFUSED row here most often means the movement had already settled. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0112R1) arrives asynchronously and is read back with getPAG0112. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitPAG0112 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0112Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0112Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Cancel a pending entry in the Câmara PAG tags: - Câmara control x-mint: href: /pt/reference/rails/siloc/cancel-a-pending-entry-in-the-camara-pag /api/v1/siloc/outbound/pending-entry-cancellations/{id}: get: description: The stored PAG0112 request projected verbatim, its dispatch state, and — once the câmara has answered — what it replied, also verbatim. The answer carries the câmara's own control number for the cancellation it registered. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0112E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). operationId: getPAG0112 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0112Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0112 instruction and its answer tags: - Câmara control x-mint: href: /pt/reference/rails/siloc/read-one-pag0112-instruction-and-its-answer /api/v1/siloc/outbound/price-history-queries: post: description: Issues a LDL1015 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Asks the prices the câmara used on a given quotation date for a given asset (Vol II, Evento LDL1015 Descrição). RLDL0010 describes which identifiers narrow the query to one asset; the official schema declares each of them optional, so the câmara rather than this rail decides whether a query is specific enough. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1015R1) arrives asynchronously and is read back with getLDL1015. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. operationId: submitLDL1015 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1015Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1015Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Query the reference prices the câmara used on a day tags: - Collateral x-mint: href: /pt/reference/rails/siloc/query-reference-prices /api/v1/siloc/outbound/price-history-queries/{id}: get: description: "The stored LDL1015 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1015E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1015 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1015Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1015 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1015-request-and-its-answer /api/v1/siloc/outbound/retail-client-to-institution-transfers: post: description: Issues a PAG0142 "IF requisita Transferência de recursos de cliente para IF por conta de operação de varejo" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds from a client to another financial institution on account of a retail operation. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0142R1) arrives asynchronously and is read back with getPAG0142. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0142 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0142Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0142Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds from a client to an institution for a retail operation tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-retail-client-to-institution /api/v1/siloc/outbound/retail-client-to-institution-transfers/{id}: get: description: "The stored PAG0142 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0142E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0142 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0142Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0142 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0142-instruction-and-its-answer /api/v1/siloc/outbound/retail-institution-to-client-transfers: post: description: Issues a PAG0143 "IF requisita Transferência de recursos de IF para cliente por conta de operação de varejo" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds to a client current account at another financial institution on account of a retail operation. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0143R1) arrives asynchronously and is read back with getPAG0143. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0143 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0143Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0143Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds from an institution to a client for a retail operation tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-retail-institution-to-client /api/v1/siloc/outbound/retail-institution-to-client-transfers/{id}: get: description: "The stored PAG0143 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0143E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0143 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0143Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0143 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0143-instruction-and-its-answer /api/v1/siloc/outbound/salary-account-transfers: post: description: Issues a PAG0137 "IF requisita Transferência de recursos envolvendo conta-salário" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds debited from a conta-salário. The debited holder is identified by CPF, because a conta-salário belongs to a natural person. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0137R1) arrives asynchronously and is read back with getPAG0137. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0137 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0137Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0137Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Transfer funds out of a salary account tags: - Transfers x-mint: href: /pt/reference/rails/siloc/transfer-funds-out-of-a-salary-account /api/v1/siloc/outbound/salary-account-transfers/{id}: get: description: "The stored PAG0137 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0137E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0137 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0137Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0137 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0137-instruction-and-its-answer /api/v1/siloc/outbound/same-holder-collateral-movements: post: description: "Issues a LDL1017 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Requests a movement of collateral for a single holder, naming the asset by the câmara's own Número Ativo and carrying the previous and new value or quantity (Vol II, Evento LDL1017 Descrição). RLDL0012: Número Controle LDL Original names the control number of the LDL1001 that required the collateral. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1017R1) arrives asynchronously and is read back with getLDL1017. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored." operationId: submitLDL1017 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1017Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1017Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Move one holder's collateral by asset number tags: - Collateral x-mint: href: /pt/reference/rails/siloc/move-one-holder-s-collateral-by-asset-number /api/v1/siloc/outbound/same-holder-collateral-movements/{id}: get: description: "The stored LDL1017 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1017E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1017 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1017Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1017 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1017-request-and-its-answer /api/v1/siloc/outbound/schedule-queries: post: description: "Issues an LDL0023 \"IF consulta Horários Câmara LDL\" to the SILOC câmara on product OT (Catálogo de Serviços do SFN v5.13, Vol II). The request is minted, built, signed, encrypted and durably recorded before anything reaches the queue: this returns 202 with the control number the câmara will echo, and the answer (LDL0023R1) arrives asynchronously — read it back with getScheduleQuery. A deployment with no send leg configured answers 503." operationId: submitScheduleQuery parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/SubmitScheduleQueryInputBody" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/ScheduleQueryResponse" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Ask the câmara for its LDL schedule grid tags: - Schedule x-mint: href: /pt/reference/rails/siloc/ask-the-camara-for-its-ldl-schedule-grid /api/v1/siloc/outbound/schedule-queries/{id}: get: description: The stored LDL0023 request, its dispatch state, and — once the câmara has answered — every grade de horário the LDL0023R1 returned, projected verbatim. status is SUBMITTED (recorded; still queued for delivery, and retried on a backoff for as long as the fault lasts), DISPATCHED (on the queue, awaiting the answer), ANSWERED, or FAILED (the official schema refused the document, which is terminal; lastError carries the diagnosis). operationId: getScheduleQuery parameters: - description: Schedule query id. in: path name: id required: true schema: description: Schedule query id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ScheduleQueryResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one schedule query and its answer tags: - Schedule x-mint: href: /pt/reference/rails/siloc/read-one-schedule-query-and-its-answer /api/v1/siloc/outbound/status-change-cancellations: post: description: Issues a PAG0203 "IF requisita cancelamento de alteração de situação" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Withdraws a situação change this institution had already registered — typically a PAG0201 that has not taken effect yet — naming it by the câmara's own control number (NumCtrlPAGOr) rather than by the NumCtrlIF this institution minted. It is the undo of the stop switch, so it carries the same operator-command treatment as the change it retires. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0203R1) arrives asynchronously and is read back with getPAG0203. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0203 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0203Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0203Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Withdraw a situação change registered in the Câmara PAG tags: - Participant situação x-mint: href: /pt/reference/rails/siloc/cancel-status-change /api/v1/siloc/outbound/status-change-cancellations/{id}: get: description: The stored PAG0203 request projected verbatim, its dispatch state, and — once the câmara has answered — what it replied, also verbatim. The answer carries the câmara's own control number for the cancellation it registered. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0203E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). operationId: getPAG0203 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0203Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0203 instruction and its answer tags: - Participant situação x-mint: href: /pt/reference/rails/siloc/read-one-pag0203-instruction-and-its-answer /api/v1/siloc/outbound/synthetic-statement-queries: post: description: "Issues a PAG0114 \"IF consulta Extrato sintético na Câmara PAG\" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Asks the câmara for the synthetic statement of the operations compensated on a movement date: per operational period, the opening deposit, the complementary deposits, the debit and credit totals, and the closing balance. The movement date is the whole of the question — the layout carries no filters. ⛔ EVERY BALANCE IN THE ANSWER IS THE CÂMARA'S, RECEIVED AND NOT COMPUTED. This rail stores each amount as the digit string the câmara wrote, renders it back unchanged, and neither derives the closing balance nor checks that it reconciles — that is the ledger consumer's work, against its own books. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0114R1) arrives asynchronously and is read back with getPAG0114. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024." operationId: submitPAG0114 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0114Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0114Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Query the synthetic statement in the Câmara PAG tags: - Câmara control x-mint: href: /pt/reference/rails/siloc/query-the-synthetic-statement-in-the-camara-pag /api/v1/siloc/outbound/synthetic-statement-queries/{id}: get: description: The stored PAG0114 request projected verbatim, its dispatch state, and — once the câmara has answered — what it replied, also verbatim. The answer carries up to 200 period rows, in the order the câmara sent them. `periods` is always present and is the empty list when the câmara returned none. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0114E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). operationId: getPAG0114 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagControlBodyPAG0114Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0114 instruction and its answer tags: - Câmara control x-mint: href: /pt/reference/rails/siloc/read-one-pag0114-instruction-and-its-answer /api/v1/siloc/outbound/undue-transfer-refunds: post: description: Issues a PAG0111 "IF requisita Transferência de recursos para devolução de transferência indevida" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests the return of funds transferred in error, or that the destination institution could not accept. It names the original Número Controle PAG and the official return reason. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0111R1) arrives asynchronously and is read back with getPAG0111. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitPAG0111 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PAG0111Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0111Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Return funds received in error tags: - Transfers x-mint: href: /pt/reference/rails/siloc/return-funds-received-in-error /api/v1/siloc/outbound/undue-transfer-refunds/{id}: get: description: "The stored PAG0111 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0111E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer's call." operationId: getPAG0111 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/PagTransferBodyPAG0111Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one PAG0111 instruction and its answer tags: - Transfers x-mint: href: /pt/reference/rails/siloc/read-one-pag0111-instruction-and-its-answer /api/v1/siloc/outbound/withdrawal-acceptance-requests: post: description: Issues a LDL1006 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Requests the câmara's acceptance of a withdrawal — voluntary or required — of guarantee, margin or securities (Vol II, Evento LDL1006 Descrição). The câmara answers per asset, accepting or rejecting each one it was sent (Evento LDL1006 Observação), so a single answer can carry both outcomes. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1006R1) arrives asynchronously and is read back with getLDL1006. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail's configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored. operationId: submitLDL1006 parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/LDL1006Payload" required: true responses: "202": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1006Payload" description: Accepted "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Ask the câmara to accept a collateral withdrawal tags: - Collateral x-mint: href: /pt/reference/rails/siloc/ask-the-camara-to-accept-a-collateral-withdrawal /api/v1/siloc/outbound/withdrawal-acceptance-requests/{id}: get: description: "The stored LDL1006 request projected verbatim, its dispatch state, and — once the câmara has answered — its Número Controle LDL plus everything else the answer carried, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the LDL1006E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). answer.details is projected VERBATIM and never decoded: the situação values the nine collateral answers carry enumerate nothing in the official types, so what one means about the collateral is the ledger consumer's call." operationId: getLDL1006 parameters: - description: Outbound message id. in: path name: id required: true schema: description: Outbound message id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/LdlCollateralBodyLDL1006Payload" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Read one LDL1006 request and its answer tags: - Collateral x-mint: href: /pt/reference/rails/siloc/read-one-ldl1006-request-and-its-answer /api/v1/siloc/participants: get: operationId: listParticipants parameters: - description: Filter by participant role. explode: false in: query name: role schema: description: Filter by participant role. enum: - DIRECT - INDIRECT - SETTLING_INSTITUTION type: string - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/ParticipantListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List participants tags: - Participants x-mint: href: /pt/reference/rails/siloc/list-participants post: description: Registers a direct or indirect participant in scope. Emits a participant.registered fact. operationId: registerParticipant parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/RegisterParticipantRequest" required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/ParticipantResponse" description: Created "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Register a participant tags: - Participants x-mint: href: /pt/reference/rails/siloc/register-participant /api/v1/siloc/participants/{participantId}: get: operationId: getParticipant parameters: - description: Participant id. in: path name: participantId required: true schema: description: Participant id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ParticipantResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get a participant tags: - Participants x-mint: href: /pt/reference/rails/siloc/get-participant put: operationId: updateParticipant parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string - description: Participant id. in: path name: participantId required: true schema: description: Participant id. format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateParticipantRequest" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ParticipantResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Update a participant tags: - Participants x-mint: href: /pt/reference/rails/siloc/update-participant /api/v1/siloc/participants/{participantId}/status: get: description: The current PAG0101 operational status and its history. operationId: getParticipantStatus parameters: - description: Participant id. in: path name: participantId required: true schema: description: Participant id. format: uuid type: string - description: CodProdt to answer for (e.g. OT). explode: false in: query name: product required: true schema: description: CodProdt to answer for (e.g. OT). examples: - OT maxLength: 3 minLength: 1 type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ParticipantStatusResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get a participant's operational status tags: - Participants x-mint: href: /pt/reference/rails/siloc/get-participant-status /api/v1/siloc/relay/messages: get: description: A cursor-paginated audit feed of funding/clearing messages relayed to Lerian SLC over the SILOC connection. operationId: listRelayedMessages parameters: - description: Filter by message direction; omit for all. explode: false in: query name: direction schema: description: Filter by message direction; omit for all. enum: - INBOUND - OUTBOUND type: string - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/RelayedMessageListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List relayed card-domain messages tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/list-relayed-messages /api/v1/siloc/relay/status: get: description: Whether the card-domain relay to Lerian SLC is healthy. When down, card settlement is blocked — this is the single point of SILOC connectivity for the card product. operationId: getRelayStatus responses: "200": content: application/json: schema: $ref: "#/components/schemas/RelayStatusResponse" description: OK "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 security: - BearerAuth: [] summary: Get the card-domain relay status tags: - Connectivity x-mint: href: /pt/reference/rails/siloc/get-relay-status /api/v1/siloc/schedule/calendar: get: description: The honored national holiday calendar for a year plus the verified BCB-artifact provenance (source, retrieval instant, sha256, covered years), projected verbatim from the compiled artifact. year defaults to the current year; a year outside the artifact's coverage returns a clean 404. operationId: getBusinessDayCalendar parameters: - description: Calendar year (defaults to the current year). explode: false in: query name: year schema: description: Calendar year (defaults to the current year). format: int64 maximum: 2100 minimum: 2000 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/BusinessDayCalendarResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get the business-day calendar tags: - Schedule x-mint: href: /pt/reference/rails/siloc/get-business-day-calendar /api/v1/siloc/schedule/camara-session: get: description: "The newest LDL0028 (abertura), LDL0029 (fechamento), LDL0030 (interrupção das atividades) and LDL0031 (retomada) the câmara sent, each projected verbatim with the câmara's OWN announced instant. A kind the câmara has never announced is omitted. No open/closed verdict is derived here: the live verdict is the active CAMARA_CLOSED / CAMARA_INTERRUPTED alert on listAlerts, flipped by the arriving notice. These notices ALARM and never affect readiness." operationId: getCamaraSession responses: "200": content: application/json: schema: $ref: "#/components/schemas/CamaraSessionResponse" description: OK "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 security: - BearerAuth: [] summary: Get the câmara's last session announcements tags: - Schedule x-mint: href: /pt/reference/rails/siloc/get-the-camara-s-last-session-announcements /api/v1/siloc/schedule/changes: get: description: "The operator-recorded contingency schedule changes, keyset-paged newest announced first. Each row is an out-of-band-received Núclea announcement (OP002 §14 = telephone/e-mail) recorded verbatim by an operator; the câmara's own wire grids are read at listScheduleGrids, and nothing here computes a schedule. Read-only — the feed is projected, never mutated through this surface." operationId: listScheduleChanges parameters: - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/ScheduleChangeListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List contingency schedule changes tags: - Schedule x-mint: href: /pt/reference/rails/siloc/list-schedule-changes post: description: "Records an out-of-band-received Núclea schedule announcement (OP002 §14 = telephone/e-mail) as an operator-entered operational fact, projected verbatim. The câmara's own wire grids (LDL0024, LDL0023R1) are read at listScheduleGrids; nothing here computes a schedule. The recorded change appends an audit row, raises the single active SCHEDULE_CHANGE alert (deadline_at = effectiveAt), and emits a schedule.change-recorded fact — all atomically. windowSeq 3 records the LBTR close Núclea announces when it extends the grade on a day BACEN declares the STR down (OP002 §14.5): the movement day's LTR0002, LTR0008 and SLC0004 stay open until it instead of 17h30, and every other code of that day (requests, and queries by their NUOp day) stays open until it instead of midnight. A close recorded after 17h30 reopens nothing the 17h30 close already failed." operationId: recordScheduleChange parameters: - description: Idempotency key for this state-changing request (required, max 255 characters). in: header name: X-Idempotency required: true schema: description: Idempotency key for this state-changing request (required, max 255 characters). maxLength: 255 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/RecordScheduleChangeInputBody" required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/ScheduleChangeResponse" description: Created "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Record a contingency schedule change tags: - Schedule x-mint: href: /pt/reference/rails/siloc/record-schedule-change /api/v1/siloc/schedule/grids: get: description: "Every grade de horário this rail received from the SILOC câmara, newest reference date first — both the unsolicited change advice (LDL0024) and the answers to schedule queries this institution issued (LDL0023R1), with source saying which leg delivered each row. Narrow with source to read one leg, or with referenceDate to read the hours that apply to one day. Projected verbatim (Catálogo de Serviços do SFN v5.13, Vol II): the câmara's own clock, its own 5-character grid code, and no canonical window resolved from either." operationId: listScheduleGrids parameters: - description: Restrict to one delivering message; omit for both legs. explode: false in: query name: source schema: description: Restrict to one delivering message; omit for both legs. enum: - LDL0024 - LDL0023R1 type: string - description: Restrict to the grids that apply to one date (DtRef), YYYY-MM-DD. explode: false in: query name: referenceDate schema: description: Restrict to the grids that apply to one date (DtRef), YYYY-MM-DD. format: date type: string - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/GridListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List the grades de horário the câmara published tags: - Schedule x-mint: href: /pt/reference/rails/siloc/list-schedule-grids /api/v1/siloc/schedule/windows: get: description: The compiled canonical OT deposit/settlement window grid (two windows per business day), projected verbatim from the pinned regulated policy — a pure read that needs no datastore and serves with the DB down. Operator-entered prorrogações are NOT merged here; they stay on listScheduleChanges. operationId: listScheduleWindows responses: "200": content: application/json: schema: $ref: "#/components/schemas/ScheduleWindowListResponse" description: OK "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 security: - BearerAuth: [] summary: List OT cycle windows tags: - Schedule x-mint: href: /pt/reference/rails/siloc/list-schedule-windows /api/v1/siloc/settlement-instructions: get: description: A cursor-paginated page of settlement obligations and their funding lifecycle state. operationId: listSettlementInstructions parameters: - description: Restrict to one cycle. explode: false in: query name: cycleId schema: description: Restrict to one cycle. format: uuid type: string - description: Filter by lifecycle state. explode: false in: query name: state schema: description: Filter by lifecycle state. enum: - RECEIVED - FUNDING_REQUIRED - CREDIT_EXPECTED - SETTLED - EXCLUDED - REPLACED type: string - description: Opaque pagination cursor. explode: false in: query name: cursor schema: description: Opaque pagination cursor. type: string - description: Page size (default 50, max 200). explode: false in: query name: limit schema: default: 50 description: Page size (default 50, max 200). format: int64 maximum: 200 minimum: 1 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/SettlementInstructionListResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: List OT settlement instructions (obligations) tags: - Settlement x-mint: href: /pt/reference/rails/siloc/list-settlement-instructions /api/v1/siloc/settlement-instructions/{instructionId}: get: operationId: getSettlementInstruction parameters: - description: Instruction id. in: path name: instructionId required: true schema: description: Instruction id. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/SettlementInstructionResponse" description: OK "422": content: application/problem+json: schema: $ref: "#/components/schemas/Detail" description: Unprocessable Entity "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 security: - BearerAuth: [] summary: Get an OT settlement instruction tags: - Settlement x-mint: href: /pt/reference/rails/siloc/get-settlement-instruction servers: - url: https://api.example.com description: Replace the example host with the URL provided during environment onboarding.