{ "openapi": "3.1.0", "info": { "title": "Plataforma Pública de Split Payment API", "description": "API REST para a Plataforma Pública de Split Payment - RTC\n\n## Documentação de Objetos e Preenchimento\n\n> ⚠️ **Observação importante:** documentação em construção.\n\n### Estrutura base das requisições\n- `InfoRequest`: objeto base para requests com `infRequisicao` e `transacoes`.\n- `InfoRequestSemCnpj`: objeto base para requests com `infRequisicao` (sem cnpjRaizPspRecDir) e `transacoes`.\n- `InfoSegRequest`: objeto base para operações de segregação sem lista de transações.\n- `InfoSegFinalRequest`: objeto de finalização com `infRequisicao` e `dadosFinalSeg`.\n\n### Objeto `infRequisicao`\n- `cnpjRaizPspRecDir`: raiz CNPJ do PSP direto (8 dígitos).\n- `dtHrMsg`: data/hora da mensagem no formato ISO 8601 com fuso `-03:00`.\n\n### Regras de preenchimento\n- Campos marcados como obrigatórios no schema devem ser sempre enviados.\n- Para endpoints com transações, o array `transacoes` deve conter objetos válidos para o arranjo do endpoint.\n- Para segregação em `/finalizacao`, enviar `infRequisicao` e `dadosFinalSeg` conforme `InfoSegFinalRequest`.\n\n## Validações aplicadas no OpenAPI\n\n### Tabela de tipos e validações\n| Tipo lógico | Tipo OpenAPI | Formato | Validações mais comuns |\n| --- | --- | --- | --- |\n| Texto/alfanumérico | `string` | - | `minLength`, `maxLength`, `pattern` |\n| Inteiro | `integer` | - | `minimum` |\n| Decimal | `number` | - | `multipleOf` (ex.: `0.01`) |\n| Data | `string` | `date` | `pattern: ^\\d{4}-\\d{2}-\\d{2}$` |\n| Data e hora | `string` | `date-time` | `pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$` |\n| Lista fechada de valores | `string` | - | `enum` |\n\n## Segurança (mTLS)\n\n### Modelo de autenticação\n- A API utiliza autenticação mútua TLS (`mutualTLS`) em nível de transporte.\n- Não é utilizado token Bearer nem API Key para autorização de chamadas.\n\n### Certificados e fluxo JWKS\n- O certificado do cliente é obtido/gerenciado conforme fluxo de segurança baseado em JWKS, de acordo com o manual de segurança da plataforma.\n- A cadeia de confiança e o material criptográfico devem estar válidos no handshake TLS antes do envio da requisição HTTP.\n- A validação do certificado ocorre no canal TLS (camada de transporte).\n\n### Restrições de conteúdo\n- `enum` para valores fechados (ex.: `arrj`: `PXA`, `PXD`, `PXE`, `BOL`, `TED`, `TEF`).\n- `minLength` e `maxLength` para tamanhos fixos/limites.\n- `pattern` para formatos estruturados (ex.: CNPJ, CPF/CNPJ, timestamps, código de barras).\n- `minimum` para inteiros com limite inferior (ex.: `numPgto >= 1`).\n- `multipleOf` para valores decimais com 2 casas (`0.01`).\n\n### Respostas de erro\n- Componentes padronizados para `400`, `403`, `422`, `500`.\n\n\n## Cabeçalhos\n\n- `X-JWS-Signature`: assinatura JWS Compact Detached (RFC 7515), com `alg=RS256`, `typ=JWS`, `kid`, `b64=false`, `jti`, `iat` e `crit=[\"b64\"]` (RFC 7797), usando payload canonicalizado em JCS (RFC 8785). `jti`: identificador único da requisição no formato UUID v4, `iat`: instante de emissão da assinatura no formato NumericDate, conforme manual de segurança.\n\n- `proximoToken`: token que indica a posição final de leitura do Retorno Super Inteligente, usado como parâmetro para a próxima requisição.\n- `streamId`: identificador do stream retornado pela API. Pode ser usado na Consulta Retroativa do Super Inteligente para indicar o stream que precisa ser consultado.\n", "contact": { "name": "SERPRO", "url": "https://www.serpro.gov.br" }, "version": "1.1.1" }, "servers": [ { "url": "http://localhost:8080", "description": "Generated server url" } ], "tags": [ { "name": "Informe de Transação Iniciada", "description": "Operações relacionadas a Informe de Transação Iniciada" }, { "name": "Informe de Transação Atualizada", "description": "Operações relacionadas a Informe de Transação Atualizada" }, { "name": "Informe Preliminar de Pagamento", "description": "Operações relacionadas a Informe Preliminar de Pagamento" }, { "name": "Informe de Baixa (Exceto por Pagamento)", "description": "Operações relacionadas a Informe de Baixa (Exceto por Pagamento)" }, { "name": "Retorno Super Inteligente", "description": "Operações relacionadas a Retorno Super Inteligente" }, { "name": "Consulta Retroativa Super Inteligente", "description": "Operações relacionadas a Consulta Retroativa Super Inteligente" }, { "name": "Informe de Segregação", "description": "Operações relacionadas a Informe de Segregação" }, { "name": "Mecanismo de Ocorrências (MOC)", "description": "Operações relacionadas ao Mecanismo de Ocorrências (MOC)" } ], "paths": { "/api/v1/boleto": { "post": { "summary": "POST - Informe de Transação Iniciada", "description": "Processa Informe de Transação Iniciada para arranjo(s): Boleto", "tags": [ "Informe de Transação Iniciada" ], "operationId": "postapiv1boleto", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeTransacaoIniciadaBoletoRequest" } } } } }, "patch": { "summary": "PATCH - Informe de Transação Atualizada", "description": "Processa Informe de Transação Atualizada para arranjo(s): Boleto", "tags": [ "Informe de Transação Atualizada" ], "operationId": "patchapiv1boleto", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeTransacaoAtualizadaBoletoRequest" } } } } } }, "/api/v1/pix-automatico": { "post": { "summary": "POST - Informe de Transação Iniciada", "description": "Processa Informe de Transação Iniciada para arranjo(s): Pix Automático", "tags": [ "Informe de Transação Iniciada" ], "operationId": "postapiv1pix_automatico", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeTransacaoIniciadaPixAutomaticoRequest" } } } } } }, "/api/v1/pix-dinamico": { "post": { "summary": "POST - Informe de Transação Iniciada", "description": "Processa Informe de Transação Iniciada para arranjo(s): Pix Dinâmico", "tags": [ "Informe de Transação Iniciada" ], "operationId": "postapiv1pix_dinamico", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeTransacaoIniciadaPixDinamicoRequest" } } } } }, "patch": { "summary": "PATCH - Informe de Transação Atualizada", "description": "Processa Informe de Transação Atualizada para arranjo(s): Pix Dinâmico", "tags": [ "Informe de Transação Atualizada" ], "operationId": "patchapiv1pix_dinamico", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeTransacaoAtualizadaPixDinamicoRequest" } } } } } }, "/api/v1/boleto/informe-preliminar-pagamento": { "post": { "summary": "POST - Informe Preliminar de Pagamento", "description": "Processa Informe Preliminar de Pagamento para arranjo(s): Boleto", "tags": [ "Informe Preliminar de Pagamento" ], "operationId": "postapiv1boletoinforme_preliminar_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformePreliminarDePagamentoBoletoRequest" } } } } } }, "/api/v1/pix-automatico/informe-preliminar-pagamento": { "post": { "summary": "POST - Informe Preliminar de Pagamento", "description": "Processa Informe Preliminar de Pagamento para arranjo(s): Pix Automático", "tags": [ "Informe Preliminar de Pagamento" ], "operationId": "postapiv1pix_automaticoinforme_preliminar_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoRequest" } } } } } }, "/api/v1/pix-dinamico/informe-preliminar-pagamento": { "post": { "summary": "POST - Informe Preliminar de Pagamento", "description": "Processa Informe Preliminar de Pagamento para arranjo(s): Pix Dinâmico", "tags": [ "Informe Preliminar de Pagamento" ], "operationId": "postapiv1pix_dinamicoinforme_preliminar_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixDinamicoRequest" } } } } } }, "/api/v1/pix-estatico/informe-preliminar-pagamento": { "post": { "summary": "POST - Informe Preliminar de Pagamento", "description": "Processa Informe Preliminar de Pagamento para arranjo(s): Pix estático", "tags": [ "Informe Preliminar de Pagamento" ], "operationId": "postapiv1pix_estaticoinforme_preliminar_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixEstaticoRequest" } } } } } }, "/api/v1/ted/informe-preliminar-pagamento": { "post": { "summary": "POST - Informe Preliminar de Pagamento", "description": "Processa Informe Preliminar de Pagamento para arranjo(s): TED", "tags": [ "Informe Preliminar de Pagamento" ], "operationId": "postapiv1tedinforme_preliminar_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformePreliminarDePagamentoTedRequest" } } } } } }, "/api/v1/tef/informe-preliminar-pagamento": { "post": { "summary": "POST - Informe Preliminar de Pagamento", "description": "Processa Informe Preliminar de Pagamento para arranjo(s): TEF", "tags": [ "Informe Preliminar de Pagamento" ], "operationId": "postapiv1tefinforme_preliminar_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformePreliminarDePagamentoTefRequest" } } } } } }, "/api/v1/boleto/baixa-exceto-pagamento": { "post": { "summary": "POST - Informe de Baixa (Exceto por Pagamento)", "description": "Processa Informe de Baixa (Exceto por Pagamento) para arranjo(s): Boleto", "tags": [ "Informe de Baixa (Exceto por Pagamento)" ], "operationId": "postapiv1boletobaixa_exceto_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeBaixaExcetoPorPagamentoBoletoRequest" } } } } } }, "/api/v1/pix-automatico/baixa-exceto-pagamento": { "post": { "summary": "POST - Informe de Baixa (Exceto por Pagamento)", "description": "Processa Informe de Baixa (Exceto por Pagamento) para arranjo(s): Pix Automático", "tags": [ "Informe de Baixa (Exceto por Pagamento)" ], "operationId": "postapiv1pix_automaticobaixa_exceto_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeBaixaExcetoPorPagamentoPixAutomaticoRequest" } } } } } }, "/api/v1/pix-dinamico/baixa-exceto-pagamento": { "post": { "summary": "POST - Informe de Baixa (Exceto por Pagamento)", "description": "Processa Informe de Baixa (Exceto por Pagamento) para arranjo(s): Pix Dinâmico", "tags": [ "Informe de Baixa (Exceto por Pagamento)" ], "operationId": "postapiv1pix_dinamicobaixa_exceto_pagamento", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeBaixaExcetoPorPagamentoPixDinamicoRequest" } } } } } }, "/api/v1/out/boleto/{cnpjRaizPspRecDir}/transacoes/stream/start": { "get": { "summary": "GET - Retorno Super Inteligente", "description": "Inicia o long polling para consumo do Retorno Super Inteligente. A chamada permanece aberta por até 6 segundos aguardando novas mensagens (este tempo pode ser ajustado pela Plataforma). Não havendo mensagens dentro da janela, a PP responde 204 e devolve o token de continuação no cabeçalho 'proximoToken'; o consumidor deve prosseguir com o proximoToken retornado.", "tags": [ "Retorno Super Inteligente" ], "operationId": "getapiv1outboleto{cnpjRaizPspRecDir}transacoesstreamstart", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Stream iniciado com sucesso. Mensagens disponíveis dentro da janela de espera do long polling.", "headers": { "streamId": { "$ref": "#/components/headers/StreamIdHeader" }, "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligenteBoletoTransacao" } } }, "required": [ "transacoes" ] } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentStreamStart" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/out/boleto/{cnpjRaizPspRecDir}/transacoes/stream/{token}": { "get": { "summary": "GET - Retorno Super Inteligente", "description": "Continua o long polling para consumo do Retorno Super Inteligente. A chamada permanece aberta por até 6 segundos aguardando novas mensagens (este tempo pode ser ajustado pela Plataforma). Não havendo mensagens dentro da janela, a PP responde 204 e devolve o token de continuação no cabeçalho 'proximoToken'; o consumidor deve prosseguir com o proximoToken retornado.", "tags": [ "Retorno Super Inteligente" ], "operationId": "getapiv1outboleto{cnpjRaizPspRecDir}transacoesstream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Mensagens disponíveis dentro da janela de espera do long polling.", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetornoSuperInteligenteBoletoRequest" } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentStreamToken" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "410": { "$ref": "#/components/responses/PPResponseGoneStream" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } }, "delete": { "summary": "DELETE - Retorno Super Inteligente", "description": "Finaliza o stream do Retorno Super Inteligente.", "tags": [ "Retorno Super Inteligente" ], "operationId": "deleteapiv1outboleto{cnpjRaizPspRecDir}transacoesstream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "204": { "description": "Stream finalizado com sucesso" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/out/pix-automatico/{cnpjRaizPspRecDir}/transacoes/stream/start": { "get": { "summary": "GET - Retorno Super Inteligente", "description": "Inicia o long polling para consumo do Retorno Super Inteligente. A chamada permanece aberta por até 6 segundos aguardando novas mensagens (este tempo pode ser ajustado pela Plataforma). Não havendo mensagens dentro da janela, a PP responde 204 e devolve o token de continuação no cabeçalho 'proximoToken'; o consumidor deve prosseguir com o proximoToken retornado.", "tags": [ "Retorno Super Inteligente" ], "operationId": "getapiv1outpix_automatico{cnpjRaizPspRecDir}transacoesstreamstart", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Stream iniciado com sucesso. Mensagens disponíveis dentro da janela de espera do long polling.", "headers": { "streamId": { "$ref": "#/components/headers/StreamIdHeader" }, "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligentePixAutomaticoTransacao" } } }, "required": [ "transacoes" ] } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentStreamStart" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/out/pix-automatico/{cnpjRaizPspRecDir}/transacoes/stream/{token}": { "get": { "summary": "GET - Retorno Super Inteligente", "description": "Continua o long polling para consumo do Retorno Super Inteligente. A chamada permanece aberta por até 6 segundos aguardando novas mensagens (este tempo pode ser ajustado pela Plataforma). Não havendo mensagens dentro da janela, a PP responde 204 e devolve o token de continuação no cabeçalho 'proximoToken'; o consumidor deve prosseguir com o proximoToken retornado.", "tags": [ "Retorno Super Inteligente" ], "operationId": "getapiv1outpix_automatico{cnpjRaizPspRecDir}transacoesstream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Mensagens disponíveis dentro da janela de espera do long polling.", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetornoSuperInteligentePixAutomaticoRequest" } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentStreamToken" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "410": { "$ref": "#/components/responses/PPResponseGoneStream" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } }, "delete": { "summary": "DELETE - Retorno Super Inteligente", "description": "Finaliza o stream do Retorno Super Inteligente.", "tags": [ "Retorno Super Inteligente" ], "operationId": "deleteapiv1outpix_automatico{cnpjRaizPspRecDir}transacoesstream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "204": { "description": "Stream finalizado com sucesso" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/out/pix-dinamico/{cnpjRaizPspRecDir}/transacoes/stream/start": { "get": { "summary": "GET - Retorno Super Inteligente", "description": "Inicia o long polling para consumo do Retorno Super Inteligente. A chamada permanece aberta por até (este tempo pode ser ajustado pela Plataforma). Não havendo mensagens dentro da janela, a PP responde 204 e devolve o token de continuação no cabeçalho 'proximoToken'; o consumidor deve prosseguir com o proximoToken retornado.", "tags": [ "Retorno Super Inteligente" ], "operationId": "getapiv1outpix_dinamico{cnpjRaizPspRecDir}transacoesstreamstart", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Stream iniciado com sucesso. Mensagens disponíveis dentro da janela de espera do long polling.", "headers": { "streamId": { "$ref": "#/components/headers/StreamIdHeader" }, "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligentePixDinamicoTransacao" } } }, "required": [ "transacoes" ] } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentStreamStart" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/out/pix-dinamico/{cnpjRaizPspRecDir}/transacoes/stream/{token}": { "get": { "summary": "GET - Retorno Super Inteligente", "description": "Continua o long polling para consumo do Retorno Super Inteligente. A chamada permanece aberta por até 6 segundos aguardando novas mensagens (este tempo pode ser ajustado pela Plataforma). Não havendo mensagens dentro da janela, a PP responde 204 e devolve o token de continuação no cabeçalho 'proximoToken'; o consumidor deve prosseguir com o proximoToken retornado.", "tags": [ "Retorno Super Inteligente" ], "operationId": "getapiv1outpix_dinamico{cnpjRaizPspRecDir}transacoesstream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Mensagens disponíveis dentro da janela de espera do long polling.", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetornoSuperInteligentePixDinamicoRequest" } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentStreamToken" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "410": { "$ref": "#/components/responses/PPResponseGoneStream" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } }, "delete": { "summary": "DELETE - Retorno Super Inteligente", "description": "Finaliza o stream do Retorno Super Inteligente.", "tags": [ "Retorno Super Inteligente" ], "operationId": "deleteapiv1outpix_dinamico{cnpjRaizPspRecDir}transacoesstream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "204": { "description": "Stream finalizado com sucesso" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/retroativo/boleto/{cnpjRaizPspRecDir}/transacoes/stream/start": { "get": { "summary": "GET - Consulta Retroativa Super Inteligente", "description": "Processa Consulta Retroativa Super Inteligente para arranjo(s): Boleto", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "getapiv1outboleto{cnpjRaizPspRecDir}transacoesretroativostreamstart", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "nsuInicial", "in": "query", "required": true, "description": "Número Sequencial Único da mensagem que se deseja iniciar a consulta retroativa de Super Inteligente.", "schema": { "type": "string", "pattern": "^\\d{1,19}$" } }, { "name": "streamId", "in": "query", "required": false, "description": "Identificador do stream que se deseja consultar.", "schema": { "type": "string" } }, { "name": "nsuFinal", "in": "query", "required": false, "description": "Número Sequencial Único da mensagem que se deseja finalizar a consulta retroativa de Super Inteligente.", "schema": { "type": "string", "pattern": "^\\d{1,19}$" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Stream iniciado com sucesso", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligenteBoletoTransacao" } } }, "required": [ "transacoes" ] } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentRetroativoStart" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/retroativo/boleto/{cnpjRaizPspRecDir}/transacoes/stream/{token}": { "get": { "summary": "GET - Consulta Retroativa Super Inteligente", "description": "Continua a Consulta Retroativa Super Inteligente para arranjo(s): Boleto", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "getapiv1outboleto{cnpjRaizPspRecDir}transacoesretroativostream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Dados da consulta", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetornoSuperInteligenteBoletoRequest" } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentRetroativoToken" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "410": { "$ref": "#/components/responses/PPResponseGoneRetroativoStream" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } }, "delete": { "summary": "DELETE - Consulta Retroativa Super Inteligente", "description": "Finaliza a Consulta Retroativa Super Inteligente para arranjo(s): Boleto", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "deleteapiv1outboleto{cnpjRaizPspRecDir}transacoesretroativostream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "204": { "description": "Stream finalizado com sucesso" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/retroativo/pix-automatico/{cnpjRaizPspRecDir}/transacoes/stream/start": { "get": { "summary": "GET - Consulta Retroativa Super Inteligente", "description": "Processa Consulta Retroativa Super Inteligente para arranjo(s): Pix Automático", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "getapiv1outpix_automatico{cnpjRaizPspRecDir}transacoesretroativostreamstart", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "nsuInicial", "in": "query", "required": true, "description": "Número Sequencial Único da mensagem que se deseja iniciar a consulta retroativa de Super Inteligente.", "schema": { "type": "string", "pattern": "^\\d{1,19}$" } }, { "name": "streamId", "in": "query", "required": false, "description": "Identificador do stream que se deseja consultar.", "schema": { "type": "string" } }, { "name": "nsuFinal", "in": "query", "required": false, "description": "Número Sequencial Único da mensagem que se deseja finalizar a consulta retroativa de Super Inteligente.", "schema": { "type": "string", "pattern": "^\\d{1,19}$" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Stream iniciado com sucesso", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligentePixAutomaticoTransacao" } } }, "required": [ "transacoes" ] } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentRetroativoStart" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/retroativo/pix-automatico/{cnpjRaizPspRecDir}/transacoes/stream/{token}": { "get": { "summary": "GET - Consulta Retroativa Super Inteligente", "description": "Continua a Consulta Retroativa Super Inteligente para arranjo(s): Pix Automático", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "getapiv1outpix_automatico{cnpjRaizPspRecDir}transacoesretroativostream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Dados da consulta", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetornoSuperInteligentePixAutomaticoRequest" } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentRetroativoToken" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "410": { "$ref": "#/components/responses/PPResponseGoneRetroativoStream" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } }, "delete": { "summary": "DELETE - Consulta Retroativa Super Inteligente", "description": "Finaliza a Consulta Retroativa Super Inteligente para arranjo(s): Pix Automático", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "deleteapiv1outpix_automatico{cnpjRaizPspRecDir}transacoesretroativostream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "204": { "description": "Stream finalizado com sucesso" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/retroativo/pix-dinamico/{cnpjRaizPspRecDir}/transacoes/stream/start": { "get": { "summary": "GET - Consulta Retroativa Super Inteligente", "description": "Processa Consulta Retroativa Super Inteligente para arranjo(s): Pix Dinâmico", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "getapiv1outpix_dinamico{cnpjRaizPspRecDir}transacoesretroativostreamstart", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "nsuInicial", "in": "query", "required": true, "description": "Número Sequencial Único da mensagem que se deseja iniciar a consulta retroativa de Super Inteligente.", "schema": { "type": "string", "pattern": "^\\d{1,19}$" } }, { "name": "streamId", "in": "query", "required": false, "description": "Identificador do stream que se deseja consultar.", "schema": { "type": "string" } }, { "name": "nsuFinal", "in": "query", "required": false, "description": "Número Sequencial Único da mensagem que se deseja finalizar a consulta retroativa de Super Inteligente.", "schema": { "type": "string", "pattern": "^\\d{1,19}$" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Stream iniciado com sucesso", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligentePixDinamicoTransacao" } } }, "required": [ "transacoes" ] } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentRetroativoStart" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/retroativo/pix-dinamico/{cnpjRaizPspRecDir}/transacoes/stream/{token}": { "get": { "summary": "GET - Consulta Retroativa Super Inteligente", "description": "Continua a Consulta Retroativa Super Inteligente para arranjo(s): Pix Dinâmico", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "getapiv1outpix_dinamico{cnpjRaizPspRecDir}transacoesretroativostream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "200": { "description": "Dados da consulta", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetornoSuperInteligentePixDinamicoRequest" } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentRetroativoToken" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "410": { "$ref": "#/components/responses/PPResponseGoneRetroativoStream" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } }, "delete": { "summary": "DELETE - Consulta Retroativa Super Inteligente", "description": "Finaliza a Consulta Retroativa Super Inteligente para arranjo(s): Pix Dinâmico", "tags": [ "Consulta Retroativa Super Inteligente" ], "operationId": "deleteapiv1outpix_dinamico{cnpjRaizPspRecDir}transacoesretroativostream{token}", "parameters": [ { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "token", "in": "path", "required": true, "description": "Token recebido na requisição anterior.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "204": { "description": "Stream finalizado com sucesso" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestConsultaStream" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityConsultaStream" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } }, "/api/v1/segregacao": { "post": { "summary": "POST - Informe de Segregação", "description": "Processa Informe de Segregação para arranjo(s): Boleto, Pix Dinâmico, Pix Automático, Pix estático, TED, TEF", "tags": [ "Informe de Segregação" ], "operationId": "postapiv1segregacao", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseCreatedSegregacao" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestSegregacao" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntitySegregacaoIniciada" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoSegregacaoRequest" } } } } } }, "/api/v1/segregacao/finalizacao": { "post": { "summary": "POST - Informe de Segregação", "description": "Processa Informe de Segregação para arranjo(s): Boleto, Pix Dinâmico, Pix Automático, Pix estático, TED, TEF", "tags": [ "Informe de Segregação" ], "operationId": "postapiv1segregacaofinalizacao", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseCreatedSegregacao" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestSegregacao" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntitySegregacaoFinalizacao" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoSegFinalRequest" } } } } } }, "/api/v1/boleto/segregacao/{idInfSegr}/lotes": { "post": { "summary": "POST - Informe de Segregação", "description": "Processa Informe de Segregação para arranjo(s): Boleto", "tags": [ "Informe de Segregação" ], "operationId": "postapiv1boletosegregacao{idInfSegr}lotes", "parameters": [ { "name": "idInfSegr", "in": "path", "required": true, "description": "Identificador do informe de segregação. Formato: ISPB da instituição devedora (8) + ISPB da instituição da comunicação efetiva (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) + data de envio do informe (AAAAMMDD) + hora de corte (HHMM) + 3 caracteres para o sequencial. Gerado pelo responsável pela comunicação.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "examples": [ "ABC123DEF456GHI7PXD202604231930001" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseCreatedLote" }, "200": { "$ref": "#/components/responses/PPResponseOkLoteAtualizado" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntitySegregacaoLote" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeSegregacaoBoletoRequest" } } } } } }, "/api/v1/pix-automatico/segregacao/{idInfSegr}/lotes": { "post": { "summary": "POST - Informe de Segregação", "description": "Processa Informe de Segregação para arranjo(s): Pix Automático", "tags": [ "Informe de Segregação" ], "operationId": "postapiv1pix_automaticosegregacao{idInfSegr}lotes", "parameters": [ { "name": "idInfSegr", "in": "path", "required": true, "description": "Identificador do informe de segregação. Formato: ISPB da instituição devedora (8) + ISPB da instituição da comunicação efetiva (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) + data de envio do informe (AAAAMMDD) + hora de corte (HHMM) + 3 caracteres para o sequencial. Gerado pelo responsável pela comunicação.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "examples": [ "ABC123DEF456GHI7PXD202604231930001" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseCreatedLote" }, "200": { "$ref": "#/components/responses/PPResponseOkLoteAtualizado" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntitySegregacaoLote" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeSegregacaoPixAutomaticoRequest" } } } } } }, "/api/v1/pix-dinamico/segregacao/{idInfSegr}/lotes": { "post": { "summary": "POST - Informe de Segregação", "description": "Processa Informe de Segregação para arranjo(s): Pix Dinâmico", "tags": [ "Informe de Segregação" ], "operationId": "postapiv1pix_dinamicosegregacao{idInfSegr}lotes", "parameters": [ { "name": "idInfSegr", "in": "path", "required": true, "description": "Identificador do informe de segregação. Formato: ISPB da instituição devedora (8) + ISPB da instituição da comunicação efetiva (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) + data de envio do informe (AAAAMMDD) + hora de corte (HHMM) + 3 caracteres para o sequencial. Gerado pelo responsável pela comunicação.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "examples": [ "ABC123DEF456GHI7PXD202604231930001" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseCreatedLote" }, "200": { "$ref": "#/components/responses/PPResponseOkLoteAtualizado" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntitySegregacaoLote" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeSegregacaoPixDinamicoRequest" } } } } } }, "/api/v1/pix-estatico/segregacao/{idInfSegr}/lotes": { "post": { "summary": "POST - Informe de Segregação", "description": "Processa Informe de Segregação para arranjo(s): Pix estático", "tags": [ "Informe de Segregação" ], "operationId": "postapiv1pix_estaticosegregacao{idInfSegr}lotes", "parameters": [ { "name": "idInfSegr", "in": "path", "required": true, "description": "Identificador do informe de segregação. Formato: ISPB da instituição devedora (8) + ISPB da instituição da comunicação efetiva (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) + data de envio do informe (AAAAMMDD) + hora de corte (HHMM) + 3 caracteres para o sequencial. Gerado pelo responsável pela comunicação.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "examples": [ "ABC123DEF456GHI7PXD202604231930001" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseCreatedLote" }, "200": { "$ref": "#/components/responses/PPResponseOkLoteAtualizado" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntitySegregacaoLote" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeSegregacaoPixEstaticoRequest" } } } } } }, "/api/v1/ted/segregacao/{idInfSegr}/lotes": { "post": { "summary": "POST - Informe de Segregação", "description": "Processa Informe de Segregação para arranjo(s): TED", "tags": [ "Informe de Segregação" ], "operationId": "postapiv1tedsegregacao{idInfSegr}lotes", "parameters": [ { "name": "idInfSegr", "in": "path", "required": true, "description": "Identificador do informe de segregação. Formato: ISPB da instituição devedora (8) + ISPB da instituição da comunicação efetiva (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) + data de envio do informe (AAAAMMDD) + hora de corte (HHMM) + 3 caracteres para o sequencial. Gerado pelo responsável pela comunicação.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "examples": [ "ABC123DEF456GHI7PXD202604231930001" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseCreatedLote" }, "200": { "$ref": "#/components/responses/PPResponseOkLoteAtualizado" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntitySegregacaoLote" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeSegregacaoTedRequest" } } } } } }, "/api/v1/tef/segregacao/{idInfSegr}/lotes": { "post": { "summary": "POST - Informe de Segregação", "description": "Processa Informe de Segregação para arranjo(s): TEF", "tags": [ "Informe de Segregação" ], "operationId": "postapiv1tefsegregacao{idInfSegr}lotes", "parameters": [ { "name": "idInfSegr", "in": "path", "required": true, "description": "Identificador do informe de segregação. Formato: ISPB da instituição devedora (8) + ISPB da instituição da comunicação efetiva (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) + data de envio do informe (AAAAMMDD) + hora de corte (HHMM) + 3 caracteres para o sequencial. Gerado pelo responsável pela comunicação.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "examples": [ "ABC123DEF456GHI7PXD202604231930001" ] } }, { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseCreatedLote" }, "200": { "$ref": "#/components/responses/PPResponseOkLoteAtualizado" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntitySegregacaoLote" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformeDeSegregacaoTefRequest" } } } } } }, "/api/v1/moc/solicitacao": { "post": { "summary": "POST - Requisição de MOC (Solicitação)", "description": "Abre Solicitação de Estorno para um máximo de 1.000 ocorrências por requisição.", "tags": [ "Mecanismo de Ocorrências (MOC)" ], "operationId": "postapiv1mocsolicitacao", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MecanismoDeOcorrenciasSolRequest" }, "examples": { "boleto-sol": { "summary": "Boleto", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "SOL12345678BOL202606230000001", "arrj": "BOL", "vlPago": 10.02, "vlCbsSegr": 5.01, "vlIbsSegr": 5.01, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "idDda": "123A512312312312FAS1", "codMotOcor": "02", "vlCbsEst": 5.01, "vlIbsEst": 5.01, "descOcor": "Solicitação de estorno para boleto", "cnpjPagOrig": "11444777000142" } ] } }, "pix-estatico-sol": { "summary": "Pix Estático", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "SOL12345678PXE202606230000008", "arrj": "PXE", "vlPago": 15.75, "vlCbsSegr": 7.88, "vlIbsSegr": 7.87, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "e2eId": "E1234567820260320123456789012345", "codMotOcor": "02", "vlCbsEst": 7.88, "vlIbsEst": 7.87, "descOcor": "Solicitação para pix estático", "cnpjPagOrig": "11444777000142" } ] } }, "pix-dinamico-sol": { "summary": "Pix Dinâmico", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "SOL12345678PXD202606230000003", "arrj": "PXD", "vlPago": 22.5, "vlCbsSegr": 11.25, "vlIbsSegr": 11.25, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "txId": "1234ABDOASD11231234ABDOASD112312345", "e2eId": "E1234567820260320123456789012345", "codMotOcor": "01", "vlCbsEst": 11.25, "vlIbsEst": 11.25, "descOcor": "Solicitação com identificacao por txId", "cnpjPagOrig": "11444777000142" } ] } }, "pix-automatico-sol": { "summary": "Pix Automático", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "SOL12345678PXA202606230000010", "arrj": "PXA", "vlPago": 30, "vlCbsSegr": 15, "vlIbsSegr": 15, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "txId": "1234ABDOASD11231234ABDOASD112312345", "e2eId": "E1234567820260320123456789012345", "codMotOcor": "01", "vlCbsEst": 15, "vlIbsEst": 15, "descOcor": "Solicitação para pix automatico", "cnpjPagOrig": "11444777000142" } ] } }, "ted-sol": { "summary": "TED", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "SOL12345678TED202606230000005", "arrj": "TED", "vlPago": 100, "vlCbsSegr": 50, "vlIbsSegr": 50, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "numCtrlTED": "STR123456789", "codMotOcor": "02", "vlCbsEst": 50, "vlIbsEst": 50, "descOcor": "Solicitação de TED com numero de controle", "cnpjPagOrig": "11444777000142" } ] } }, "tef-sol": { "summary": "TEF", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "SOL12345678TEF202606230000012", "arrj": "TEF", "vlPago": 75, "vlCbsSegr": 37.5, "vlIbsSegr": 37.5, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "numCtrlTEF": "TEF123456789", "codMotOcor": "02", "vlCbsEst": 37.5, "vlIbsEst": 37.5, "descOcor": "Solicitação para TEF", "cnpjPagOrig": "11444777000142" } ] } } } } } } } }, "/api/v1/moc/notificacao": { "post": { "summary": "POST - Requisição de MOC (Notificação)", "description": "Envia Notificação de transações em Análise no máximo de 1.000 ocorrências por requisicao.", "tags": [ "Mecanismo de Ocorrências (MOC)" ], "operationId": "postapiv1mocnotificacao", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" } ], "responses": { "201": { "$ref": "#/components/responses/PPResponseOk" }, "400": { "$ref": "#/components/responses/PPResponseBadRequest" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "500": { "$ref": "#/components/responses/PPResponseError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MecanismoDeOcorrenciasNotRequest" }, "examples": { "boleto-not": { "summary": "Boleto", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "NOT12345678BOL202606230000007", "arrj": "BOL", "vlPago": 10.02, "vlCbsSegr": 5.01, "vlIbsSegr": 5.01, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "idDda": "123A512312312312FAS1", "descOcor": "Notificação para boleto", "cnpjPagOrig": "11444777000142" } ] } }, "pix-estatico-not": { "summary": "Pix Estático", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "NOT12345678PXE202606230000002", "arrj": "PXE", "vlPago": 15.75, "vlCbsSegr": 7.88, "vlIbsSegr": 7.87, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "e2eId": "E1234567820260320123456789012345", "descOcor": "Notificação Pix estático", "cnpjPagOrig": "11444777000142" } ] } }, "pix-dinamico-not": { "summary": "Pix Dinâmico", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "NOT12345678PXD202606230000009", "arrj": "PXD", "vlPago": 22.5, "vlCbsSegr": 11.25, "vlIbsSegr": 11.25, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "txId": "1234ABDOASD11231234ABDOASD112312345", "e2eId": "E1234567820260320123456789012345", "descOcor": "Notificação para pix dinâmico", "cnpjPagOrig": "11444777000142" } ] } }, "pix-automatico-not": { "summary": "Pix Automático", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "NOT12345678PXA202606230000004", "arrj": "PXA", "vlPago": 30, "vlCbsSegr": 15, "vlIbsSegr": 15, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "txId": "1234ABDOASD11231234ABDOASD112312345", "e2eId": "E1234567820260320123456789012345", "orgRespProcAdm": "RFB", "numProcAdm": "PROC2026000123", "descOcor": "Notificação para pix automático", "cnpjPagOrig": "11444777000142" } ] } }, "ted-not": { "summary": "TED", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "NOT12345678TED202606230000011", "arrj": "TED", "vlPago": 100, "vlCbsSegr": 50, "vlIbsSegr": 50, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "numCtrlTED": "STR123456789", "descOcor": "Notificação para TED", "cnpjPagOrig": "11444777000142" } ] } }, "tef-not": { "summary": "TEF", "value": { "infRequisicao": { "dtHrMsg": "2026-03-22T12:00:00-03:00" }, "ocorrencias": [ { "index": 1, "idOcor": "NOT12345678TEF202606230000006", "arrj": "TEF", "vlPago": 75, "vlCbsSegr": 37.5, "vlIbsSegr": 37.5, "dtHrPgto": "2026-03-22T11:30:00-03:00", "dtHrLiq": "2026-03-22T11:31:00-03:00", "cnpjCpfPagEfet": "11444777000142", "cnpjRaizPspPag": "12345678", "cnpjRaizPspRecDir": "87654321", "cnpjRec": "11444777000142", "cnpjCpfDest": "11444777000142", "numCtrlTEF": "TEF123456789", "orgRespProcAdm": "CGIBS", "numProcAdm": "PROC2026000456", "descOcor": "Notificação para TEF", "cnpjPagOrig": "11444777000142" } ] } } } } } } } }, "/api/v1/moc/{cnpjRaizPspRecDir}/ocorrencias": { "get": { "summary": "GET - Consulta de MOC", "description": "Consulta paginada (polling) das ocorrências do MOC com resposta para o PSP. A Plataforma responde imediatamente com as ocorrências disponíveis no momento (até 1.000 por página). O parâmetro 'nsuInicial' deve ser utilizado para continuar a paginação a partir do último NSU já recebido, a primeira consulta deve usar o valor inicial: 1. O parâmetro opcional 'limite' permite definir a quantidade máxima de ocorrências retornadas por página, respeitado o limite de 1.000 itens. O retorno HTTP 204 indica que não há mais ocorrências disponíveis no momento — seja porque todas as ocorrências já foram retornadas, seja porque não há ocorrências. Nesse caso o PSP deve aguardar 30 minutos antes de realizar uma nova consulta. A Plataforma não mantém a conexão aberta aguardando ocorrências (estratégia de polling).", "tags": [ "Mecanismo de Ocorrências (MOC)" ], "operationId": "getapiv1moc{cnpjRaizPspRecDir}ocorrencias", "parameters": [ { "$ref": "#/components/parameters/XJwsSignatureHeaderParam" }, { "name": "cnpjRaizPspRecDir", "in": "path", "required": true, "description": "Raiz do CNPJ do PSP Recebedor Direto: 8 caracteres alfanuméricos.", "schema": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ] } }, { "name": "nsuInicial", "in": "query", "required": true, "description": "NSU inicial utilizado para a paginação dos resultados de ocorrências do MOC.", "schema": { "type": "string", "pattern": "^\\d{1,19}$", "examples": [ "1234567890123456789" ] } }, { "name": "limite", "in": "query", "required": false, "description": "Quantidade máxima de ocorrências retornadas por página. Padrão e máximo: 1.000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "examples": [ 1000 ] } } ], "responses": { "200": { "description": "Consulta realizada com sucesso. Ocorrências disponíveis no momento da consulta.", "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MocOcorrenciasConsultaResponse" } } } }, "204": { "$ref": "#/components/responses/PPResponseNoContentMocConsultaStart" }, "400": { "$ref": "#/components/responses/PPResponseBadRequestMocConsulta" }, "403": { "$ref": "#/components/responses/PPResponseForbidden" }, "422": { "$ref": "#/components/responses/PPResponseUnprocessableEntityMocConsulta" }, "500": { "$ref": "#/components/responses/PPResponseError" } } } } }, "components": { "schemas": { "InfoRequest": { "type": "object", "properties": { "infRequisicao": { "type": "object", "properties": { "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "dtHrMsg": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-22T12:00:00-03:00" ], "description": "Data e hora da mensagem que está sendo transmitida entre PSP/Núclea e a Plataforma Pública." } }, "required": [ "cnpjRaizPspRecDir", "dtHrMsg" ] }, "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "object", "properties": {}, "required": [] } } }, "required": [ "infRequisicao", "transacoes" ] }, "InfoRequestSemCnpj": { "type": "object", "properties": { "infRequisicao": { "type": "object", "properties": { "dtHrMsg": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-22T12:00:00-03:00" ], "description": "Data e hora da mensagem que está sendo transmitida entre PSP/Núclea e a Plataforma Pública." } }, "required": [ "dtHrMsg" ] }, "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "object", "properties": {}, "required": [] } } }, "required": [ "infRequisicao", "transacoes" ] }, "InfoSegRequest": { "type": "object", "properties": { "infRequisicao": { "type": "object", "properties": { "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "dtHrMsg": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-22T12:00:00-03:00" ], "description": "Data e hora da mensagem que está sendo transmitida entre PSP/Núclea e a Plataforma Pública." } }, "required": [ "cnpjRaizPspRecDir", "dtHrMsg" ] } }, "required": [ "infRequisicao" ] }, "InfoSegFinalRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoSegRequest" }, { "properties": { "dadosFinalSeg": { "$ref": "#/components/schemas/DadosFinalSegRequest" } }, "required": [ "dadosFinalSeg" ] } ] }, "DadosInfoSegRequest": { "type": "object", "properties": { "idRepasse": { "type": "string", "minLength": 30, "maxLength": 30, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{11}$", "examples": [ "ABC123DEF456GHI7PXD20260423001" ], "description": "Identificador do Repasse Financeiro associado à transação. Formato: ISPB do PSP Recebedor Direto (8) + ISPB da instituição do repasse efetivo (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) + data definida para realização do Repasse Financeiro (AAAAMMDD) + 3 caracteres para o sequencial. Gerado pelo PSP Recebedor Direto. Um mesmo idRepasse é utilizado para os dois tributos do Repasse Financeiro: CBS (via TES) e IBS (via STR), sendo comum a ambos." }, "arrj": { "type": "string", "enum": [ "PXA", "PXD", "PXE", "BOL", "TED", "TEF" ], "examples": [ "PXD" ], "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF." }, "idInfSegr": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "examples": [ "ABC123DEF456GHI7PXD202604231930001" ], "description": "Identificador do informe de segregação, gerado pelo responsável pela comunicação. Formato: ISPB do PSP Recebedor Direto (8) + ISPB da instituição da comunicação efetiva (8) + arranjo (PXA/PXD/PXE/BOL/TED/TEF) + data de envio (AAAAMMDD) + hora de corte HHMM (horário de corte do arranjo, conforme o Manual de Tempos) + sequencial (3)." } }, "required": [ "idRepasse", "arrj", "idInfSegr" ] }, "DadosLoteSegRequest": { "type": "object", "properties": { "idLote": { "type": "string", "minLength": 40, "maxLength": 40, "pattern": "^[A-Za-z0-9]{34}\\d{6}$", "examples": [ "ZZ99YY88XX77WW66VV55UU44TT33SS22RR000001", "ZZ99YY88XX77WW66VV55UU44TT33SS22RR000002" ], "description": "Identificador do lote enviado no informe de segregação. Formato: IdInfSegr + sequencial" } }, "required": [ "idLote" ] }, "DadosFinalSegRequest": { "type": "object", "properties": { "idInfSegr": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[A-Za-z0-9]{16}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "examples": [ "ABC123DEF456GHI7PXD202604231930001" ], "description": "Identificador do informe de segregação, gerado pelo responsável pela comunicação. Formato: ISPB do PSP Recebedor Direto (8) + ISPB da instituição da comunicação efetiva (8) + arranjo (PXA/PXD/PXE/BOL/TED/TEF) + data de envio (AAAAMMDD) + hora de corte HHMM (horário de corte do arranjo, conforme o Manual de Tempos) + sequencial (3)." }, "totalTrans": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 99999999999999999, "examples": [ 100, 99, 0 ], "description": "Número total de transações enviadas no Informe de Segregação" }, "vlTotalCbs": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 1500.5 ], "description": "Valor total de CBS enviado no Informe de Segregação" }, "vlTotalIbs": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 750.25 ], "description": "Valor total de IBS enviado no Informe de Segregação" } }, "required": [ "idInfSegr", "totalTrans", "vlTotalCbs", "vlTotalIbs" ] }, "InformeDeTransacaoIniciadaBoletoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "idDda": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador único do documento de cobrança no sistema DDA." }, "numCtrlOrig": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador utilizado pela Núclea para controle interno da transação." }, "numCodBarras": { "type": "string", "minLength": 44, "maxLength": 44, "pattern": "^\\d{44}$", "examples": [ "12345678901234567891123456789012345678911234" ], "description": "Número correspondente ao código de barras do boleto." }, "vlInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor da transação informado pelo originador ao preencher (emitir) a transação." }, "vlCbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS informado pelo originador no preenchimento da transação." }, "vlIbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS informado pelo originador no preenchimento da transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos." }, "dtHrIni": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora de emissão da transação após processamento pelo PSP/Núclea." }, "dtVenc": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "examples": [ "2026-03-20" ], "description": "Data de vencimento da transação." }, "dtHrLimPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora limite para realização do pagamento da transação." } }, "required": [ "index", "idDda", "numCtrlOrig", "numCodBarras", "vlInf", "vlCbsInf", "vlIbsInf", "cnpjRaizPspRecDir", "cnpjRec", "cnpjPagOrig", "dtHrIni", "dtVenc", "dtHrLimPgto" ] }, "InformeDeTransacaoIniciadaBoletoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeTransacaoIniciadaBoletoTransacao" } } } } ] }, "InformeDeTransacaoIniciadaPixAutomaticoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "vlInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor da transação informado pelo originador ao preencher (emitir) a transação." }, "vlCbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS informado pelo originador no preenchimento da transação." }, "vlIbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS informado pelo originador no preenchimento da transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos." }, "dtHrIni": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora de emissão da transação após processamento pelo PSP/Núclea." }, "dtVenc": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "examples": [ "2026-03-20" ], "description": "Data de vencimento da transação." }, "dtHrLimPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora limite para realização do pagamento da transação." } }, "required": [ "index", "txId", "vlInf", "vlCbsInf", "vlIbsInf", "cnpjRaizPspRecDir", "cnpjRec", "dtHrIni", "dtHrLimPgto" ] }, "InformeDeTransacaoIniciadaPixAutomaticoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeTransacaoIniciadaPixAutomaticoTransacao" } } } } ] }, "InformeDeTransacaoIniciadaPixDinamicoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "vlInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor da transação informado pelo originador ao preencher (emitir) a transação." }, "vlCbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS informado pelo originador no preenchimento da transação." }, "vlIbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS informado pelo originador no preenchimento da transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos." }, "dtHrIni": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora de emissão da transação após processamento pelo PSP/Núclea." }, "dtVenc": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "examples": [ "2026-03-20" ], "description": "Data de vencimento da transação." }, "dtHrLimPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora limite para realização do pagamento da transação." } }, "required": [ "index", "txId", "vlInf", "vlCbsInf", "vlIbsInf", "cnpjRaizPspRecDir", "cnpjRec", "dtHrIni", "dtHrLimPgto" ] }, "InformeDeTransacaoIniciadaPixDinamicoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeTransacaoIniciadaPixDinamicoTransacao" } } } } ] }, "InformeDeTransacaoAtualizadaBoletoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "idDda": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador único do documento de cobrança no sistema DDA." }, "numCtrlOrig": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador utilizado pela Núclea para controle interno da transação." }, "vlInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor da transação informado pelo originador ao preencher (emitir) a transação." }, "vlCbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS informado pelo originador no preenchimento da transação." }, "vlIbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS informado pelo originador no preenchimento da transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "dtHrAtu": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora da atualização da transação." }, "dtVenc": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "examples": [ "2026-03-20" ], "description": "Data de vencimento da transação." }, "dtHrLimPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora limite para realização do pagamento da transação." } }, "required": [ "index", "idDda", "numCtrlOrig", "vlInf", "vlCbsInf", "vlIbsInf", "cnpjRaizPspRecDir", "dtHrAtu", "dtVenc", "dtHrLimPgto" ] }, "InformeDeTransacaoAtualizadaBoletoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeTransacaoAtualizadaBoletoTransacao" } } } } ] }, "InformeDeTransacaoAtualizadaPixDinamicoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "vlInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor da transação informado pelo originador ao preencher (emitir) a transação." }, "vlCbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS informado pelo originador no preenchimento da transação." }, "vlIbsInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS informado pelo originador no preenchimento da transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos." }, "dtHrAtu": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora da atualização da transação." }, "dtVenc": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "examples": [ "2026-03-20" ], "description": "Data de vencimento da transação." }, "dtHrLimPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora limite para realização do pagamento da transação." } }, "required": [ "index", "txId", "vlInf", "vlCbsInf", "vlIbsInf", "cnpjRaizPspRecDir", "cnpjRec", "dtHrAtu", "dtHrLimPgto" ] }, "InformeDeTransacaoAtualizadaPixDinamicoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeTransacaoAtualizadaPixDinamicoTransacao" } } } } ] }, "InformePreliminarDePagamentoBoletoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "idDda": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador único do documento de cobrança no sistema DDA." }, "numCtrlOrig": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador utilizado pela Núclea para controle interno da transação." }, "numPgto": { "type": "integer", "minimum": 1, "examples": [ 1 ], "maximum": 999999999, "description": "Indica a sequência do pagamento no arranjo (ex.: quantidade de pagamentos do boleto)." }, "numIdentcBaixa": { "type": "string", "pattern": "^\\d{1,19}$", "examples": [ "1234567890123456789", "9999999999999999999" ], "description": "Identificador específico do evento de baixa da transação." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "indPgtoIntegral": { "type": "string", "enum": [ "0", "1" ], "examples": [ "1" ], "description": "Indica se a transação foi integralmente paga, considerando todos os pagamentos até o momento. 1 = pagamento integral; 0 = não integral." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." } }, "required": [ "index", "idDda", "numCtrlOrig", "numPgto", "numIdentcBaixa", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "indPgtoIntegral", "cnpjRaizPspPag", "cnpjRec", "dtHrPgto" ] }, "InformePreliminarDePagamentoBoletoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformePreliminarDePagamentoBoletoTransacao" } } } } ] }, "InformePreliminarDePagamentoPixAutomaticoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "e2eId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação no arranjo de pagamentos Pix (E2EID)." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." } }, "required": [ "index", "txId", "e2eId", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq" ] }, "InformePreliminarDePagamentoPixAutomaticoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao" } } } } ] }, "InformePreliminarDePagamentoPixDinamicoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "e2eId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação no arranjo de pagamentos Pix (E2EID)." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." } }, "required": [ "index", "txId", "e2eId", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq" ] }, "InformePreliminarDePagamentoPixDinamicoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixDinamicoTransacao" } } } } ] }, "InformePreliminarDePagamentoPixEstaticoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "e2eId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação no arranjo de pagamentos Pix (E2EID)." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." } }, "required": [ "index", "e2eId", "vlPago", "vlCbsSegr", "vlIbsSegr", "docFiscal", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq" ] }, "InformePreliminarDePagamentoPixEstaticoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixEstaticoTransacao" } } } } ] }, "InformePreliminarDePagamentoTedTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "numCtrlTED": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação TED gerado na liquidação (NumCtrlSTR ou NumCtrlPAG)." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." } }, "required": [ "index", "numCtrlTED", "vlPago", "vlCbsSegr", "vlIbsSegr", "docFiscal", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjCpfPagEfet", "dtHrLiq" ] }, "InformePreliminarDePagamentoTedRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformePreliminarDePagamentoTedTransacao" } } } } ] }, "InformePreliminarDePagamentoTefTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "numCtrlTEF": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador da transação TEF gerado pelo PSP." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." } }, "required": [ "index", "numCtrlTEF", "vlPago", "vlCbsSegr", "vlIbsSegr", "docFiscal", "cnpjRaizPspRecDir", "cnpjRec", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq" ] }, "InformePreliminarDePagamentoTefRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformePreliminarDePagamentoTefTransacao" } } } } ] }, "InformeDeBaixaExcetoPorPagamentoBoletoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "idDda": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador único do documento de cobrança no sistema DDA." }, "numCtrlOrig": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador utilizado pela Núclea para controle interno da transação." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "dtHrBaixa": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora da baixa da transação sem ocorrência de pagamento." } }, "required": [ "index", "idDda", "numCtrlOrig", "cnpjRaizPspRecDir", "dtHrBaixa" ] }, "InformeDeBaixaExcetoPorPagamentoBoletoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeBaixaExcetoPorPagamentoBoletoTransacao" } } } } ] }, "InformeDeBaixaExcetoPorPagamentoPixAutomaticoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "dtHrBaixa": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora da baixa da transação sem ocorrência de pagamento." } }, "required": [ "index", "txId", "cnpjRaizPspRecDir", "dtHrBaixa" ] }, "InformeDeBaixaExcetoPorPagamentoPixAutomaticoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeBaixaExcetoPorPagamentoPixAutomaticoTransacao" } } } } ] }, "InformeDeBaixaExcetoPorPagamentoPixDinamicoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "dtHrBaixa": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora da baixa da transação sem ocorrência de pagamento." } }, "required": [ "index", "txId", "cnpjRaizPspRecDir", "dtHrBaixa" ] }, "InformeDeBaixaExcetoPorPagamentoPixDinamicoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequestSemCnpj" }, { "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeBaixaExcetoPorPagamentoPixDinamicoTransacao" } } } } ] }, "CodMsgEnum": { "type": "string", "enum": [ "RSUP101", "RSUP102", "RSUP103", "RSUP104", "RSUP201", "RSUP202", "RSUP203", "RSUP204", "RSUP601", "RSUP602", "RSUP603", "RSUP604" ], "examples": [ "RSUP101", "RSUP203" ], "description": "Código identificador da mensagem, conforme o arranjo aplicável (ex.: RSUP101, RSUP102)." }, "RetornoSuperInteligenteBoletoTransacao": { "type": "object", "properties": { "codMsg": { "$ref": "#/components/schemas/CodMsgEnum" }, "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "Número Sequencial Único da mensagem (Super Inteligente)", "examples": [ "1234567890123456789" ] }, "dtHrDisp": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que a Plataforma Pública disponibilizou a mensagem do Retorno Super Inteligente para consumo." }, "idDda": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador único do documento de cobrança no sistema DDA." }, "numCtrlOrig": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador utilizado pela Núclea para controle interno da transação." }, "vlInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor da transação informado pelo originador ao preencher (emitir) a transação." }, "vlCbsCorr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS corrigido pela RFB, quando divergente do Documento Fiscal vinculado." }, "vlIbsCorr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS corrigido pelo Comitê Gestor do IBS, quando divergente do Documento Fiscal vinculado." }, "vlCbsAberto": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS não extinto do Documento Fiscal vinculado à transação, conforme retorno da RFB." }, "vlIbsAberto": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS não extinto do Documento Fiscal vinculado à transação, conforme retorno do Comitê Gestor do IBS." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." } }, "required": [ "codMsg", "nsuId", "idDda", "numCtrlOrig", "vlInf", "cnpjRaizPspRecDir", "dtHrDisp" ] }, "RetornoSuperInteligenteBoletoRequest": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligenteBoletoTransacao" } } }, "required": [ "transacoes" ] }, "RetornoSuperInteligentePixAutomaticoTransacao": { "type": "object", "properties": { "codMsg": { "$ref": "#/components/schemas/CodMsgEnum" }, "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "Número Sequencial Único da mensagem (Super Inteligente)", "examples": [ "1234567890123456789" ] }, "dtHrDisp": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que a Plataforma Pública disponibilizou a mensagem do Retorno Super Inteligente para consumo." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "vlInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor da transação informado pelo originador ao preencher (emitir) a transação." }, "vlCbsCorr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS corrigido pela RFB, quando divergente do Documento Fiscal vinculado." }, "vlIbsCorr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS corrigido pelo Comitê Gestor do IBS, quando divergente do Documento Fiscal vinculado." }, "vlCbsAberto": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS não extinto do Documento Fiscal vinculado à transação, conforme retorno da RFB." }, "vlIbsAberto": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS não extinto do Documento Fiscal vinculado à transação, conforme retorno do Comitê Gestor do IBS." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." } }, "required": [ "codMsg", "nsuId", "txId", "vlInf", "cnpjRaizPspRecDir", "cnpjRec", "dtHrDisp" ] }, "RetornoSuperInteligentePixAutomaticoRequest": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligentePixAutomaticoTransacao" } } }, "required": [ "transacoes" ] }, "RetornoSuperInteligentePixDinamicoTransacao": { "type": "object", "properties": { "codMsg": { "$ref": "#/components/schemas/CodMsgEnum" }, "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "Número Sequencial Único da mensagem (Super Inteligente)", "examples": [ "1234567890123456789" ] }, "dtHrDisp": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que a Plataforma Pública disponibilizou a mensagem do Retorno Super Inteligente para consumo." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "vlInf": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor da transação informado pelo originador ao preencher (emitir) a transação." }, "vlCbsCorr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS corrigido pela RFB, quando divergente do Documento Fiscal vinculado." }, "vlIbsCorr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS corrigido pelo Comitê Gestor do IBS, quando divergente do Documento Fiscal vinculado." }, "vlCbsAberto": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS não extinto do Documento Fiscal vinculado à transação, conforme retorno da RFB." }, "vlIbsAberto": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS não extinto do Documento Fiscal vinculado à transação, conforme retorno do Comitê Gestor do IBS." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "12345678" ], "description": "Raiz do CNPJ do PSP Recebedor Direto." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." } }, "required": [ "codMsg", "nsuId", "txId", "vlInf", "cnpjRaizPspRecDir", "cnpjRec", "dtHrDisp" ] }, "RetornoSuperInteligentePixDinamicoRequest": { "type": "object", "properties": { "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/RetornoSuperInteligentePixDinamicoTransacao" } } }, "required": [ "transacoes" ] }, "InfoSegregacaoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoSegRequest" }, { "properties": { "dadosInfoSeg": { "$ref": "#/components/schemas/DadosInfoSegRequest" } }, "required": [ "dadosInfoSeg" ] } ] }, "InformeDeSegregacaoBoletoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "idDda": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador único do documento de cobrança no sistema DDA." }, "numCtrlOrig": { "type": "string", "minLength": 1, "maxLength": 20, "examples": [ "123A512312312312FAS1" ], "description": "Identificador utilizado pela Núclea para controle interno da transação." }, "numPgto": { "type": "integer", "minimum": 1, "examples": [ 1 ], "maximum": 999999999, "description": "Indica a sequência do pagamento no arranjo (ex.: quantidade de pagamentos do boleto)." }, "numIdentcBaixa": { "type": "string", "pattern": "^\\d{1,19}$", "examples": [ "1234567890123456789", "9999999999999999999" ], "description": "Identificador específico do evento de baixa da transação." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "indPgtoIntegral": { "type": "string", "enum": [ "0", "1" ], "examples": [ "1" ], "description": "Indica se a transação foi integralmente paga, considerando todos os pagamentos até o momento. 1 = pagamento integral; 0 = não integral." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "dtHrRepasse": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora-limite para o envio do Repasse Financeiro de CBS à RFB e de IBS ao Comitê Gestor. Corresponde a 12:00 (meio-dia) de D+N, conforme o Manual de Tempos (seção 6.2)." } }, "required": [ "index", "idDda", "numCtrlOrig", "numPgto", "numIdentcBaixa", "vlPago", "vlCbsSegr", "vlIbsSegr", "indPgtoIntegral", "cnpjRaizPspPag", "cnpjRec", "dtHrPgto", "dtHrLiq", "dtHrRepasse" ] }, "InformeDeSegregacaoBoletoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequest" }, { "properties": { "dadosLoteSeg": { "$ref": "#/components/schemas/DadosLoteSegRequest" }, "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeSegregacaoBoletoTransacao" } } }, "required": [ "dadosLoteSeg", "transacoes" ] } ] }, "InformeDeSegregacaoPixAutomaticoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "e2eId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação no arranjo de pagamentos Pix (E2EID)." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "dtHrRepasse": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora-limite para o envio do Repasse Financeiro de CBS à RFB e de IBS ao Comitê Gestor. Corresponde a 12:00 (meio-dia) de D+N, conforme o Manual de Tempos (seção 6.2)." } }, "required": [ "index", "txId", "e2eId", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspPag", "cnpjRec", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq", "dtHrRepasse" ] }, "InformeDeSegregacaoPixAutomaticoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequest" }, { "properties": { "dadosLoteSeg": { "$ref": "#/components/schemas/DadosLoteSegRequest" }, "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeSegregacaoPixAutomaticoTransacao" } } }, "required": [ "dadosLoteSeg", "transacoes" ] } ] }, "InformeDeSegregacaoPixDinamicoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "txId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação Pix (TxID)." }, "e2eId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação no arranjo de pagamentos Pix (E2EID)." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "dtHrRepasse": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora-limite para o envio do Repasse Financeiro de CBS à RFB e de IBS ao Comitê Gestor. Corresponde a 12:00 (meio-dia) de D+N, conforme o Manual de Tempos (seção 6.2)." } }, "required": [ "index", "txId", "e2eId", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspPag", "cnpjRec", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq", "dtHrRepasse" ] }, "InformeDeSegregacaoPixDinamicoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequest" }, { "properties": { "dadosLoteSeg": { "$ref": "#/components/schemas/DadosLoteSegRequest" }, "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeSegregacaoPixDinamicoTransacao" } } }, "required": [ "dadosLoteSeg", "transacoes" ] } ] }, "InformeDeSegregacaoPixEstaticoTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "e2eId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "1234ABDOASD11231234ABDOASD112312345" ], "description": "Identificador único da transação no arranjo de pagamentos Pix (E2EID)." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspRecInd": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Recebedor Indireto onde o Recebedor mantém a conta." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "dtHrRepasse": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora-limite para o envio do Repasse Financeiro de CBS à RFB e de IBS ao Comitê Gestor. Corresponde a 12:00 (meio-dia) de D+N, conforme o Manual de Tempos (seção 6.2)." } }, "required": [ "index", "e2eId", "vlPago", "vlCbsSegr", "vlIbsSegr", "docFiscal", "cnpjRaizPspPag", "cnpjRec", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq", "dtHrRepasse" ] }, "InformeDeSegregacaoPixEstaticoRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequest" }, { "properties": { "dadosLoteSeg": { "$ref": "#/components/schemas/DadosLoteSegRequest" }, "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeSegregacaoPixEstaticoTransacao" } } }, "required": [ "dadosLoteSeg", "transacoes" ] } ] }, "InformeDeSegregacaoTedTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "numCtrlTED": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "TED123456789" ], "description": "Identificador único da transação TED gerado na liquidação (NumCtrlSTR ou NumCtrlPAG)." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "examples": [ "87654321" ], "description": "Raiz do CNPJ do PSP Pagador." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "dtHrRepasse": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora-limite para o envio do Repasse Financeiro de CBS à RFB e de IBS ao Comitê Gestor. Corresponde a 12:00 (meio-dia) de D+N, conforme o Manual de Tempos (seção 6.2)." } }, "required": [ "index", "numCtrlTED", "vlPago", "vlCbsSegr", "vlIbsSegr", "docFiscal", "cnpjRaizPspPag", "cnpjRec", "cnpjCpfPagEfet", "dtHrLiq", "dtHrRepasse" ] }, "InformeDeSegregacaoTedRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequest" }, { "properties": { "dadosLoteSeg": { "$ref": "#/components/schemas/DadosLoteSegRequest" }, "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeSegregacaoTedTransacao" } } }, "required": [ "dadosLoteSeg", "transacoes" ] } ] }, "InformeDeSegregacaoTefTransacao": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1." }, "numCtrlTEF": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "TEF123456789" ], "description": "Identificador da transação TEF gerado pelo PSP." }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "1234567890123456789B123A5678901234567891123412345" ], "description": "Identificador do Documento Fiscal vinculado à transação." }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "examples": [ "11444777000142" ], "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos)." }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "examples": [ "11444777000142" ], "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos." }, "dtHrPgto": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "dtHrRepasse": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-03-20T10:33:46-03:00" ], "description": "Data e hora-limite para o envio do Repasse Financeiro de CBS à RFB e de IBS ao Comitê Gestor. Corresponde a 12:00 (meio-dia) de D+N, conforme o Manual de Tempos (seção 6.2)." } }, "required": [ "index", "numCtrlTEF", "vlPago", "vlCbsSegr", "vlIbsSegr", "docFiscal", "cnpjRec", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq", "dtHrRepasse" ] }, "InformeDeSegregacaoTefRequest": { "allOf": [ { "$ref": "#/components/schemas/InfoRequest" }, { "properties": { "dadosLoteSeg": { "$ref": "#/components/schemas/DadosLoteSegRequest" }, "transacoes": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/InformeDeSegregacaoTefTransacao" } } }, "required": [ "dadosLoteSeg", "transacoes" ] } ] }, "MocOcorrencia": { "description": "Ocorrência do MOC. O discriminador principal e arrj (arranjo): cada arranjo exige o(s) identificador(es) de transacao correspondente(s).", "oneOf": [ { "$ref": "#/components/schemas/MocOcorrenciaBoleto" }, { "$ref": "#/components/schemas/MocOcorrenciaPixEstatico" }, { "$ref": "#/components/schemas/MocOcorrenciaPixDinamico" }, { "$ref": "#/components/schemas/MocOcorrenciaPixAutomatico" }, { "$ref": "#/components/schemas/MocOcorrenciaTed" }, { "$ref": "#/components/schemas/MocOcorrenciaTef" } ], "discriminator": { "propertyName": "arrj", "mapping": { "BOL": "#/components/schemas/MocOcorrenciaBoleto", "PXE": "#/components/schemas/MocOcorrenciaPixEstatico", "PXD": "#/components/schemas/MocOcorrenciaPixDinamico", "PXA": "#/components/schemas/MocOcorrenciaPixAutomatico", "TED": "#/components/schemas/MocOcorrenciaTed", "TEF": "#/components/schemas/MocOcorrenciaTef" } } }, "MocOcorrenciaRetorno": { "description": "Retorno de ocorrência do MOC (resposta da RFB/CGIBS), na consulta paginada. O discriminador é arrj: cada arranjo exige o(s) identificador(es) de transação correspondente(s), conforme a matriz 3.9.4.1.", "oneOf": [ { "$ref": "#/components/schemas/MocOcorrenciaRetornoBoleto" }, { "$ref": "#/components/schemas/MocOcorrenciaRetornoPixAutomatico" }, { "$ref": "#/components/schemas/MocOcorrenciaRetornoPixDinamico" }, { "$ref": "#/components/schemas/MocOcorrenciaRetornoPixEstatico" }, { "$ref": "#/components/schemas/MocOcorrenciaRetornoTed" }, { "$ref": "#/components/schemas/MocOcorrenciaRetornoTef" } ], "discriminator": { "propertyName": "arrj", "mapping": { "BOL": "#/components/schemas/MocOcorrenciaRetornoBoleto", "PXA": "#/components/schemas/MocOcorrenciaRetornoPixAutomatico", "PXD": "#/components/schemas/MocOcorrenciaRetornoPixDinamico", "PXE": "#/components/schemas/MocOcorrenciaRetornoPixEstatico", "TED": "#/components/schemas/MocOcorrenciaRetornoTed", "TEF": "#/components/schemas/MocOcorrenciaRetornoTef" } } }, "MocOcorrenciasConsultaResponse": { "type": "object", "properties": { "ocorrencias": { "type": "array", "minItems": 1, "maxItems": 1000, "description": "Página de ocorrências com resposta. Máximo de 1.000 itens por página.", "items": { "$ref": "#/components/schemas/MocOcorrenciaRetorno" } } }, "required": [ "ocorrencias" ] }, "MocOcorrenciaBoleto": { "type": "object", "description": "Ocorrência do arranjo Boleto (estrutura achatada). Campos válidos e obrigatoriedade conforme o Manual; additionalProperties=false impede campos não previstos.", "additionalProperties": false, "properties": { "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "BOL", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "BOL" ] }, "idDda": { "$ref": "#/components/schemas/InformePreliminarDePagamentoBoletoTransacao/properties/idDda" }, "numIdentcBaixa": { "$ref": "#/components/schemas/InformePreliminarDePagamentoBoletoTransacao/properties/numIdentcBaixa" }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "description": "Identificador do Documento Fiscal vinculado à transação.", "examples": [ "1234567890123456789B123A5678901234567891123412345" ] }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Recebedor Direto.", "examples": [ "12345678" ] }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Pagador.", "examples": [ "12345678" ] }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos).", "examples": [ "11444777000142" ] }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "dtHrPgto": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T09:00:00-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T10:00:00-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "index": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1.", "examples": [ 1 ] }, "codMotOcor": { "$ref": "#/components/schemas/CodMotOcorEnum" }, "descOcor": { "type": "string", "maxLength": 100, "description": "Texto livre complementar ao motivo da ocorrência.", "examples": [ "Transação retida para análise de segurança" ] }, "orgRespProcAdm": { "type": "string", "minLength": 1, "maxLength": 8, "description": "Órgão responsável pelo processo administrativo associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "RFB" ] }, "numProcAdm": { "type": "string", "minLength": 1, "maxLength": 20, "description": "Número do ofício, processo administrativo ou ordem judicial associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "PROC2026000123" ] }, "vlCbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS solicitado para estorno (Solicitação de Estorno)." }, "vlIbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS solicitado para estorno (Solicitação de Estorno)." }, "cnpjCpfDest": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador (CNPJ/CPF) da parte prejudicada, que receberá de volta o valor do tributo estornado. CPF: 11 dígitos; CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] } }, "required": [ "arrj", "idDda", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjPagOrig", "dtHrPgto", "dtHrLiq", "idOcor", "index", "cnpjCpfDest" ] }, "MocOcorrenciaPixEstatico": { "type": "object", "description": "Ocorrência do arranjo Pix Estático (estrutura achatada). Campos válidos e obrigatoriedade conforme o Manual; additionalProperties=false impede campos não previstos.", "additionalProperties": false, "properties": { "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "PXE", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "PXE" ] }, "e2eId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/e2eId" }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "description": "Identificador do Documento Fiscal vinculado à transação.", "examples": [ "1234567890123456789B123A5678901234567891123412345" ] }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Recebedor Direto.", "examples": [ "12345678" ] }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Pagador.", "examples": [ "12345678" ] }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos).", "examples": [ "11444777000142" ] }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "dtHrPgto": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T09:00:00-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T10:00:00-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "index": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1.", "examples": [ 1 ] }, "codMotOcor": { "$ref": "#/components/schemas/CodMotOcorEnum" }, "descOcor": { "type": "string", "maxLength": 100, "description": "Texto livre complementar ao motivo da ocorrência.", "examples": [ "Transação retida para análise de segurança" ] }, "orgRespProcAdm": { "type": "string", "minLength": 1, "maxLength": 8, "description": "Órgão responsável pelo processo administrativo associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "RFB" ] }, "numProcAdm": { "type": "string", "minLength": 1, "maxLength": 20, "description": "Número do ofício, processo administrativo ou ordem judicial associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "PROC2026000123" ] }, "vlCbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS solicitado para estorno (Solicitação de Estorno)." }, "vlIbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS solicitado para estorno (Solicitação de Estorno)." }, "cnpjCpfDest": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador (CNPJ/CPF) da parte prejudicada, que receberá de volta o valor do tributo estornado. CPF: 11 dígitos; CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] } }, "required": [ "arrj", "e2eId", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjPagOrig", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq", "idOcor", "index", "cnpjCpfDest" ] }, "MocOcorrenciaPixDinamico": { "type": "object", "description": "Ocorrência do arranjo Pix Dinâmico (estrutura achatada). Campos válidos e obrigatoriedade conforme o Manual; additionalProperties=false impede campos não previstos.", "additionalProperties": false, "properties": { "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "PXD", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "PXD" ] }, "txId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/txId" }, "e2eId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/e2eId" }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "description": "Identificador do Documento Fiscal vinculado à transação.", "examples": [ "1234567890123456789B123A5678901234567891123412345" ] }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Recebedor Direto.", "examples": [ "12345678" ] }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Pagador.", "examples": [ "12345678" ] }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos).", "examples": [ "11444777000142" ] }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "dtHrPgto": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T09:00:00-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T10:00:00-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "index": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1.", "examples": [ 1 ] }, "codMotOcor": { "$ref": "#/components/schemas/CodMotOcorEnum" }, "descOcor": { "type": "string", "maxLength": 100, "description": "Texto livre complementar ao motivo da ocorrência.", "examples": [ "Transação retida para análise de segurança" ] }, "orgRespProcAdm": { "type": "string", "minLength": 1, "maxLength": 8, "description": "Órgão responsável pelo processo administrativo associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "RFB" ] }, "numProcAdm": { "type": "string", "minLength": 1, "maxLength": 20, "description": "Número do ofício, processo administrativo ou ordem judicial associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "PROC2026000123" ] }, "vlCbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS solicitado para estorno (Solicitação de Estorno)." }, "vlIbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS solicitado para estorno (Solicitação de Estorno)." }, "cnpjCpfDest": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador (CNPJ/CPF) da parte prejudicada, que receberá de volta o valor do tributo estornado. CPF: 11 dígitos; CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] } }, "required": [ "arrj", "txId", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjPagOrig", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq", "idOcor", "index", "cnpjCpfDest" ] }, "MocOcorrenciaPixAutomatico": { "type": "object", "description": "Ocorrência do arranjo Pix Automático (estrutura achatada). Campos válidos e obrigatoriedade conforme o Manual; additionalProperties=false impede campos não previstos.", "additionalProperties": false, "properties": { "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "PXA", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "PXA" ] }, "txId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/txId" }, "e2eId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/e2eId" }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "description": "Identificador do Documento Fiscal vinculado à transação.", "examples": [ "1234567890123456789B123A5678901234567891123412345" ] }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Recebedor Direto.", "examples": [ "12345678" ] }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Pagador.", "examples": [ "12345678" ] }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos).", "examples": [ "11444777000142" ] }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "dtHrPgto": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T09:00:00-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T10:00:00-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "index": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1.", "examples": [ 1 ] }, "codMotOcor": { "$ref": "#/components/schemas/CodMotOcorEnum" }, "descOcor": { "type": "string", "maxLength": 100, "description": "Texto livre complementar ao motivo da ocorrência.", "examples": [ "Transação retida para análise de segurança" ] }, "orgRespProcAdm": { "type": "string", "minLength": 1, "maxLength": 8, "description": "Órgão responsável pelo processo administrativo associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "RFB" ] }, "numProcAdm": { "type": "string", "minLength": 1, "maxLength": 20, "description": "Número do ofício, processo administrativo ou ordem judicial associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "PROC2026000123" ] }, "vlCbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS solicitado para estorno (Solicitação de Estorno)." }, "vlIbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS solicitado para estorno (Solicitação de Estorno)." }, "cnpjCpfDest": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador (CNPJ/CPF) da parte prejudicada, que receberá de volta o valor do tributo estornado. CPF: 11 dígitos; CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] } }, "required": [ "arrj", "txId", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjPagOrig", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq", "idOcor", "index", "cnpjCpfDest" ] }, "MocOcorrenciaTed": { "type": "object", "description": "Ocorrência do arranjo TED (estrutura achatada). Campos válidos e obrigatoriedade conforme o Manual; additionalProperties=false impede campos não previstos.", "additionalProperties": false, "properties": { "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "TED", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "TED" ] }, "numCtrlTED": { "$ref": "#/components/schemas/InformePreliminarDePagamentoTedTransacao/properties/numCtrlTED" }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "description": "Identificador do Documento Fiscal vinculado à transação.", "examples": [ "1234567890123456789B123A5678901234567891123412345" ] }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Recebedor Direto.", "examples": [ "12345678" ] }, "cnpjRaizPspPag": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Pagador.", "examples": [ "12345678" ] }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos).", "examples": [ "11444777000142" ] }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "dtHrLiq": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T10:00:00-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "index": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1.", "examples": [ 1 ] }, "codMotOcor": { "$ref": "#/components/schemas/CodMotOcorEnum" }, "descOcor": { "type": "string", "maxLength": 100, "description": "Texto livre complementar ao motivo da ocorrência.", "examples": [ "Transação retida para análise de segurança" ] }, "orgRespProcAdm": { "type": "string", "minLength": 1, "maxLength": 8, "description": "Órgão responsável pelo processo administrativo associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "RFB" ] }, "numProcAdm": { "type": "string", "minLength": 1, "maxLength": 20, "description": "Número do ofício, processo administrativo ou ordem judicial associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "PROC2026000123" ] }, "vlCbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS solicitado para estorno (Solicitação de Estorno)." }, "vlIbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS solicitado para estorno (Solicitação de Estorno)." }, "cnpjCpfDest": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador (CNPJ/CPF) da parte prejudicada, que receberá de volta o valor do tributo estornado. CPF: 11 dígitos; CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] } }, "required": [ "arrj", "numCtrlTED", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "cnpjRaizPspPag", "cnpjRec", "cnpjPagOrig", "cnpjCpfPagEfet", "dtHrLiq", "idOcor", "index", "cnpjCpfDest" ] }, "MocOcorrenciaTef": { "type": "object", "description": "Ocorrência do arranjo TEF (estrutura achatada). Campos válidos e obrigatoriedade conforme o Manual; additionalProperties=false impede campos não previstos.", "additionalProperties": false, "properties": { "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "TEF", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "TEF" ] }, "numCtrlTEF": { "$ref": "#/components/schemas/InformePreliminarDePagamentoTefTransacao/properties/numCtrlTEF" }, "vlPago": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor efetivamente pago na transação." }, "vlCbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "vlIbsSegr": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS efetivamente segregado pelo PSP Recebedor Direto na transação." }, "docFiscal": { "type": "string", "minLength": 1, "maxLength": 50, "description": "Identificador do Documento Fiscal vinculado à transação.", "examples": [ "1234567890123456789B123A5678901234567891123412345" ] }, "cnpjRaizPspRecDir": { "type": "string", "minLength": 8, "maxLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Raiz do CNPJ do PSP Recebedor Direto.", "examples": [ "12345678" ] }, "cnpjRec": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificação do Recebedor (que recebe o valor líquido da transação). Em caso de cessão de recebíveis, preencher com o Recebedor original (e não com o novo detentor de direitos).", "examples": [ "11444777000142" ] }, "cnpjPagOrig": { "type": "string", "minLength": 14, "maxLength": 14, "pattern": "^[A-Za-z0-9]{14}$", "description": "Identificador do Pagador informado na emissão da transação. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "cnpjCpfPagEfet": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador do Pagador que efetivamente realizou o pagamento. CPF: 11 dígitos. CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] }, "dtHrPgto": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T09:00:00-03:00" ], "description": "Data e hora em que o pagamento foi realizado pelo Pagador." }, "dtHrLiq": { "type": "string", "minLength": 25, "maxLength": 25, "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T10:00:00-03:00" ], "description": "Data e hora em que ocorreu a efetiva Liquidação Interbancária ou Intrabancária no arranjo." }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "index": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Número sequencial do item na lista enviada, iniciando em 1.", "examples": [ 1 ] }, "codMotOcor": { "$ref": "#/components/schemas/CodMotOcorEnum" }, "descOcor": { "type": "string", "maxLength": 100, "description": "Texto livre complementar ao motivo da ocorrência.", "examples": [ "Transação retida para análise de segurança" ] }, "orgRespProcAdm": { "type": "string", "minLength": 1, "maxLength": 8, "description": "Órgão responsável pelo processo administrativo associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "RFB" ] }, "numProcAdm": { "type": "string", "minLength": 1, "maxLength": 20, "description": "Número do ofício, processo administrativo ou ordem judicial associado à ocorrência (Notificação de Transação em Análise).", "examples": [ "PROC2026000123" ] }, "vlCbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS solicitado para estorno (Solicitação de Estorno)." }, "vlIbsEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de IBS solicitado para estorno (Solicitação de Estorno)." }, "cnpjCpfDest": { "type": "string", "minLength": 11, "maxLength": 14, "pattern": "^(\\d{11}|[A-Za-z0-9]{14})$", "description": "Identificador (CNPJ/CPF) da parte prejudicada, que receberá de volta o valor do tributo estornado. CPF: 11 dígitos; CNPJ: 14 caracteres alfanuméricos.", "examples": [ "11444777000142" ] } }, "required": [ "arrj", "numCtrlTEF", "vlPago", "vlCbsSegr", "vlIbsSegr", "cnpjRaizPspRecDir", "cnpjRec", "cnpjPagOrig", "cnpjCpfPagEfet", "dtHrPgto", "dtHrLiq", "idOcor", "index", "cnpjCpfDest" ] }, "MocOcorrenciaSol": { "allOf": [ { "$ref": "#/components/schemas/MocOcorrencia" }, { "type": "object", "required": [ "codMotOcor", "vlCbsEst", "vlIbsEst" ], "not": { "anyOf": [ { "required": [ "orgRespProcAdm" ] }, { "required": [ "numProcAdm" ] } ] } } ] }, "MocOcorrenciaNot": { "allOf": [ { "$ref": "#/components/schemas/MocOcorrencia" }, { "type": "object", "not": { "anyOf": [ { "required": [ "codMotOcor" ] }, { "required": [ "vlCbsEst" ] }, { "required": [ "vlIbsEst" ] } ] } } ] }, "MecanismoDeOcorrenciasSolRequest": { "type": "object", "properties": { "infRequisicao": { "type": "object", "properties": { "dtHrMsg": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T12:00:00-03:00" ], "description": "Data e hora da mensagem que está sendo transmitida entre PSP/Núclea e a Plataforma Pública." } }, "required": [ "dtHrMsg" ] }, "ocorrencias": { "type": "array", "minItems": 1, "maxItems": 1000, "description": "Lista de ocorrências do MOC. Máximo de 1.000 por requisição.", "items": { "$ref": "#/components/schemas/MocOcorrenciaSol" } } }, "required": [ "infRequisicao", "ocorrencias" ], "description": "Requisicao MOC contendo exclusivamente ocorrencias de solicitacao." }, "MecanismoDeOcorrenciasNotRequest": { "type": "object", "properties": { "infRequisicao": { "type": "object", "properties": { "dtHrMsg": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T12:00:00-03:00" ], "description": "Data e hora da mensagem que está sendo transmitida entre PSP/Núclea e a Plataforma Pública." } }, "required": [ "dtHrMsg" ] }, "ocorrencias": { "type": "array", "minItems": 1, "maxItems": 1000, "description": "Lista de ocorrências do MOC. Máximo de 1.000 por requisição.", "items": { "$ref": "#/components/schemas/MocOcorrenciaNot" } } }, "required": [ "infRequisicao", "ocorrencias" ], "description": "Requisicao MOC contendo exclusivamente ocorrencias de notificacao." }, "CodParecerEnum": { "type": "string", "enum": [ "01", "02", "03" ], "examples": [ "01", "02", "03" ], "description": "Código do parecer sobre a solicitação de estorno via MOC associada à transação. 01= Aceita, 02 = Aceita Parcialmente, 03 = Não aceita", "minLength": 2, "maxLength": 2 }, "CodMotOcorEnum": { "type": "string", "minLength": 2, "maxLength": 2, "enum": [ "01", "02" ], "description": "Código do motivo da ocorrência (Solicitação de Estorno): 01 = Incidente de segurança; 02 = Falha operacional (Atores Financeiros).", "examples": [ "01", "02" ] }, "OrgRespResEnum": { "type": "string", "minLength": 3, "maxLength": 5, "enum": [ "RFB", "CGIBS" ], "description": "Órgão que respondeu à solicitação de estorno: RFB (Receita Federal do Brasil) ou CGIBS (Comitê Gestor do IBS). Presente no Retorno da Solicitação de Estorno.", "examples": [ "RFB", "CGIBS" ] }, "TpTribEnum": { "type": "string", "enum": [ "CBS", "IBS" ], "examples": [ "CBS", "IBS" ], "description": "Tributo a que se refere o parecer: CBS (Contribuição sobre Bens e Serviços) ou IBS (Imposto sobre Bens e Serviços). Presente no Retorno da Solicitação de Estorno.", "minLength": 3, "maxLength": 3 }, "MocOcorrenciaRetornoBoleto": { "type": "object", "description": "Retorno de ocorrência do MOC — arranjo Boleto (estrutura achatada). Campos e obrigatoriedade conforme a matriz 3.9.4.1; additionalProperties=false impede campos não previstos. idAprovEst é exigido apenas quando codParecer é 01 ou 02.", "additionalProperties": false, "properties": { "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "NSU da ocorrência retornada, utilizado na paginação dos resultados do MOC.", "examples": [ "1234567890123456789" ] }, "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "BOL", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "BOL" ] }, "idDda": { "$ref": "#/components/schemas/InformePreliminarDePagamentoBoletoTransacao/properties/idDda" }, "numIdentcBaixa": { "$ref": "#/components/schemas/InformePreliminarDePagamentoBoletoTransacao/properties/numIdentcBaixa" }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "dtHrEnvOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T12:00:00-03:00" ], "description": "Data e hora de envio da ocorrência pelo responsável da abertura do MOC." }, "dtHrRespOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-24T15:00:00-03:00" ], "description": "Data e hora da resposta da ocorrência pela RFB/CGIBS. Presente apenas no Retorno da Solicitação de Estorno." }, "orgRespRes": { "$ref": "#/components/schemas/OrgRespResEnum" }, "codParecer": { "$ref": "#/components/schemas/CodParecerEnum" }, "tpTrib": { "$ref": "#/components/schemas/TpTribEnum" }, "vlTribEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS ou IBS aprovado para estorno, conforme tpTrib. Presente no Retorno da Solicitação de Estorno." }, "descParecer": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Descrição complementar do parecer da RFB/CGIBS. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Ocorrência respondida pelo órgão competente" ] }, "orientSolic": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Orientação à parte solicitante quanto ao acompanhamento da ocorrência. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Consultar retorno da ocorrência para acompanhamento" ] }, "idAprovEst": { "type": "string", "minLength": 20, "maxLength": 20, "description": "Identificador de aprovação do estorno via MOC, emitido pela RFB ou CGIBS. Corresponde ao número de controle enviado na mensagem de estorno no SPB, conforme o tributo: NumCtrlTESOr para CBS e NumCtrlSTROr para IBS. Preenchimento condicional: retornado somente quando codParecer for 01 (Aceita) ou 02 (Aceita Parcialmente).", "examples": [ "APV20260623000100001" ] } }, "required": [ "nsuId", "arrj", "idDda", "idOcor", "dtHrEnvOcor", "dtHrRespOcor", "orgRespRes", "codParecer", "tpTrib", "vlTribEst" ], "allOf": [ { "if": { "properties": { "codParecer": { "enum": [ "01", "02" ] } }, "required": [ "codParecer" ] }, "then": { "required": [ "idAprovEst" ] }, "else": { "not": { "required": [ "idAprovEst" ] } } } ] }, "MocOcorrenciaRetornoPixAutomatico": { "type": "object", "description": "Retorno de ocorrência do MOC — arranjo Pix Automático (estrutura achatada). Campos e obrigatoriedade conforme a matriz 3.9.4.1; additionalProperties=false impede campos não previstos. idAprovEst é exigido apenas quando codParecer é 01 ou 02.", "additionalProperties": false, "properties": { "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "NSU da ocorrência retornada, utilizado na paginação dos resultados do MOC.", "examples": [ "1234567890123456789" ] }, "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "PXA", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "PXA" ] }, "txId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/txId" }, "e2eId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/e2eId" }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "dtHrEnvOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T12:00:00-03:00" ], "description": "Data e hora de envio da ocorrência pelo responsável da abertura do MOC." }, "dtHrRespOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-24T15:00:00-03:00" ], "description": "Data e hora da resposta da ocorrência pela RFB/CGIBS. Presente apenas no Retorno da Solicitação de Estorno." }, "orgRespRes": { "$ref": "#/components/schemas/OrgRespResEnum" }, "codParecer": { "$ref": "#/components/schemas/CodParecerEnum" }, "tpTrib": { "$ref": "#/components/schemas/TpTribEnum" }, "vlTribEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS ou IBS aprovado para estorno, conforme tpTrib. Presente no Retorno da Solicitação de Estorno." }, "descParecer": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Descrição complementar do parecer da RFB/CGIBS. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Ocorrência respondida pelo órgão competente" ] }, "orientSolic": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Orientação à parte solicitante quanto ao acompanhamento da ocorrência. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Consultar retorno da ocorrência para acompanhamento" ] }, "idAprovEst": { "type": "string", "minLength": 20, "maxLength": 20, "description": "Identificador de aprovação do estorno via MOC, emitido pela RFB ou CGIBS. Corresponde ao número de controle enviado na mensagem de estorno no SPB, conforme o tributo: NumCtrlTESOr para CBS e NumCtrlSTROr para IBS. Preenchimento condicional: retornado somente quando codParecer for 01 (Aceita) ou 02 (Aceita Parcialmente).", "examples": [ "APV20260623000100001" ] } }, "required": [ "nsuId", "arrj", "txId", "idOcor", "dtHrEnvOcor", "dtHrRespOcor", "orgRespRes", "codParecer", "tpTrib", "vlTribEst" ], "allOf": [ { "if": { "properties": { "codParecer": { "enum": [ "01", "02" ] } }, "required": [ "codParecer" ] }, "then": { "required": [ "idAprovEst" ] }, "else": { "not": { "required": [ "idAprovEst" ] } } } ] }, "MocOcorrenciaRetornoPixDinamico": { "type": "object", "description": "Retorno de ocorrência do MOC — arranjo Pix Dinâmico (estrutura achatada). Campos e obrigatoriedade conforme a matriz 3.9.4.1; additionalProperties=false impede campos não previstos. idAprovEst é exigido apenas quando codParecer é 01 ou 02.", "additionalProperties": false, "properties": { "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "NSU da ocorrência retornada, utilizado na paginação dos resultados do MOC.", "examples": [ "1234567890123456789" ] }, "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "PXD", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "PXD" ] }, "txId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/txId" }, "e2eId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/e2eId" }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "dtHrEnvOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T12:00:00-03:00" ], "description": "Data e hora de envio da ocorrência pelo responsável da abertura do MOC." }, "dtHrRespOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-24T15:00:00-03:00" ], "description": "Data e hora da resposta da ocorrência pela RFB/CGIBS. Presente apenas no Retorno da Solicitação de Estorno." }, "orgRespRes": { "$ref": "#/components/schemas/OrgRespResEnum" }, "codParecer": { "$ref": "#/components/schemas/CodParecerEnum" }, "tpTrib": { "$ref": "#/components/schemas/TpTribEnum" }, "vlTribEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS ou IBS aprovado para estorno, conforme tpTrib. Presente no Retorno da Solicitação de Estorno." }, "descParecer": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Descrição complementar do parecer da RFB/CGIBS. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Ocorrência respondida pelo órgão competente" ] }, "orientSolic": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Orientação à parte solicitante quanto ao acompanhamento da ocorrência. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Consultar retorno da ocorrência para acompanhamento" ] }, "idAprovEst": { "type": "string", "minLength": 20, "maxLength": 20, "description": "Identificador de aprovação do estorno via MOC, emitido pela RFB ou CGIBS. Corresponde ao número de controle enviado na mensagem de estorno no SPB, conforme o tributo: NumCtrlTESOr para CBS e NumCtrlSTROr para IBS. Preenchimento condicional: retornado somente quando codParecer for 01 (Aceita) ou 02 (Aceita Parcialmente).", "examples": [ "APV20260623000100001" ] } }, "required": [ "nsuId", "arrj", "txId", "idOcor", "dtHrEnvOcor", "dtHrRespOcor", "orgRespRes", "codParecer", "tpTrib", "vlTribEst" ], "allOf": [ { "if": { "properties": { "codParecer": { "enum": [ "01", "02" ] } }, "required": [ "codParecer" ] }, "then": { "required": [ "idAprovEst" ] }, "else": { "not": { "required": [ "idAprovEst" ] } } } ] }, "MocOcorrenciaRetornoPixEstatico": { "type": "object", "description": "Retorno de ocorrência do MOC — arranjo Pix Estático (estrutura achatada). Campos e obrigatoriedade conforme a matriz 3.9.4.1; additionalProperties=false impede campos não previstos. idAprovEst é exigido apenas quando codParecer é 01 ou 02.", "additionalProperties": false, "properties": { "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "NSU da ocorrência retornada, utilizado na paginação dos resultados do MOC.", "examples": [ "1234567890123456789" ] }, "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "PXE", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "PXE" ] }, "e2eId": { "$ref": "#/components/schemas/InformePreliminarDePagamentoPixAutomaticoTransacao/properties/e2eId" }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "dtHrEnvOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T12:00:00-03:00" ], "description": "Data e hora de envio da ocorrência pelo responsável da abertura do MOC." }, "dtHrRespOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-24T15:00:00-03:00" ], "description": "Data e hora da resposta da ocorrência pela RFB/CGIBS. Presente apenas no Retorno da Solicitação de Estorno." }, "orgRespRes": { "$ref": "#/components/schemas/OrgRespResEnum" }, "codParecer": { "$ref": "#/components/schemas/CodParecerEnum" }, "tpTrib": { "$ref": "#/components/schemas/TpTribEnum" }, "vlTribEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS ou IBS aprovado para estorno, conforme tpTrib. Presente no Retorno da Solicitação de Estorno." }, "descParecer": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Descrição complementar do parecer da RFB/CGIBS. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Ocorrência respondida pelo órgão competente" ] }, "orientSolic": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Orientação à parte solicitante quanto ao acompanhamento da ocorrência. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Consultar retorno da ocorrência para acompanhamento" ] }, "idAprovEst": { "type": "string", "minLength": 20, "maxLength": 20, "description": "Identificador de aprovação do estorno via MOC, emitido pela RFB ou CGIBS. Corresponde ao número de controle enviado na mensagem de estorno no SPB, conforme o tributo: NumCtrlTESOr para CBS e NumCtrlSTROr para IBS. Preenchimento condicional: retornado somente quando codParecer for 01 (Aceita) ou 02 (Aceita Parcialmente).", "examples": [ "APV20260623000100001" ] } }, "required": [ "nsuId", "arrj", "e2eId", "idOcor", "dtHrEnvOcor", "dtHrRespOcor", "orgRespRes", "codParecer", "tpTrib", "vlTribEst" ], "allOf": [ { "if": { "properties": { "codParecer": { "enum": [ "01", "02" ] } }, "required": [ "codParecer" ] }, "then": { "required": [ "idAprovEst" ] }, "else": { "not": { "required": [ "idAprovEst" ] } } } ] }, "MocOcorrenciaRetornoTed": { "type": "object", "description": "Retorno de ocorrência do MOC — arranjo TED (estrutura achatada). Campos e obrigatoriedade conforme a matriz 3.9.4.1; additionalProperties=false impede campos não previstos. idAprovEst é exigido apenas quando codParecer é 01 ou 02.", "additionalProperties": false, "properties": { "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "NSU da ocorrência retornada, utilizado na paginação dos resultados do MOC.", "examples": [ "1234567890123456789" ] }, "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "TED", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "TED" ] }, "numCtrlTED": { "$ref": "#/components/schemas/InformePreliminarDePagamentoTedTransacao/properties/numCtrlTED" }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "dtHrEnvOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T12:00:00-03:00" ], "description": "Data e hora de envio da ocorrência pelo responsável da abertura do MOC." }, "dtHrRespOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-24T15:00:00-03:00" ], "description": "Data e hora da resposta da ocorrência pela RFB/CGIBS. Presente apenas no Retorno da Solicitação de Estorno." }, "orgRespRes": { "$ref": "#/components/schemas/OrgRespResEnum" }, "codParecer": { "$ref": "#/components/schemas/CodParecerEnum" }, "tpTrib": { "$ref": "#/components/schemas/TpTribEnum" }, "vlTribEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS ou IBS aprovado para estorno, conforme tpTrib. Presente no Retorno da Solicitação de Estorno." }, "descParecer": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Descrição complementar do parecer da RFB/CGIBS. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Ocorrência respondida pelo órgão competente" ] }, "orientSolic": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Orientação à parte solicitante quanto ao acompanhamento da ocorrência. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Consultar retorno da ocorrência para acompanhamento" ] }, "idAprovEst": { "type": "string", "minLength": 20, "maxLength": 20, "description": "Identificador de aprovação do estorno via MOC, emitido pela RFB ou CGIBS. Corresponde ao número de controle enviado na mensagem de estorno no SPB, conforme o tributo: NumCtrlTESOr para CBS e NumCtrlSTROr para IBS. Preenchimento condicional: retornado somente quando codParecer for 01 (Aceita) ou 02 (Aceita Parcialmente).", "examples": [ "APV20260623000100001" ] } }, "required": [ "nsuId", "arrj", "numCtrlTED", "idOcor", "dtHrEnvOcor", "dtHrRespOcor", "orgRespRes", "codParecer", "tpTrib", "vlTribEst" ], "allOf": [ { "if": { "properties": { "codParecer": { "enum": [ "01", "02" ] } }, "required": [ "codParecer" ] }, "then": { "required": [ "idAprovEst" ] }, "else": { "not": { "required": [ "idAprovEst" ] } } } ] }, "MocOcorrenciaRetornoTef": { "type": "object", "description": "Retorno de ocorrência do MOC — arranjo TEF (estrutura achatada). Campos e obrigatoriedade conforme a matriz 3.9.4.1; additionalProperties=false impede campos não previstos. idAprovEst é exigido apenas quando codParecer é 01 ou 02.", "additionalProperties": false, "properties": { "nsuId": { "type": "string", "pattern": "^\\d{1,19}$", "description": "NSU da ocorrência retornada, utilizado na paginação dos resultados do MOC.", "examples": [ "1234567890123456789" ] }, "arrj": { "type": "string", "minLength": 3, "maxLength": 3, "const": "TEF", "description": "Arranjo financeiro ao qual a mensagem está associada (Pix Automático, Pix Dinâmico, Pix Estático, Boleto, TED, TEF). O campo prevê os seguintes valores: PXA, PXD, PXE, BOL, TED ou TEF.", "examples": [ "TEF" ] }, "numCtrlTEF": { "$ref": "#/components/schemas/InformePreliminarDePagamentoTefTransacao/properties/numCtrlTEF" }, "idOcor": { "type": "string", "minLength": 29, "maxLength": 29, "pattern": "^(SOL|NOT)[A-Za-z0-9]{8}(PXA|PXD|PXE|BOL|TED|TEF)\\d{15}$", "description": "Identificador único da ocorrência do MOC. Formato: prefixo do tipo (SOL ou NOT) (3) + raiz do CNPJ do PSP Recebedor Direto (8) + arranjo (PXA, PXD, PXE, BOL, TED, TEF) (3) + data da solicitação (AAAAMMDD) (8) + 7 caracteres para o contador. Gerado pelo PSP Recebedor Direto.", "examples": [ "SOL12345678PXD202606230000001" ] }, "dtHrEnvOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-23T12:00:00-03:00" ], "description": "Data e hora de envio da ocorrência pelo responsável da abertura do MOC." }, "dtHrRespOcor": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}-03:00$", "examples": [ "2026-06-24T15:00:00-03:00" ], "description": "Data e hora da resposta da ocorrência pela RFB/CGIBS. Presente apenas no Retorno da Solicitação de Estorno." }, "orgRespRes": { "$ref": "#/components/schemas/OrgRespResEnum" }, "codParecer": { "$ref": "#/components/schemas/CodParecerEnum" }, "tpTrib": { "$ref": "#/components/schemas/TpTribEnum" }, "vlTribEst": { "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 999999999999999999.99, "examples": [ 10.02 ], "description": "Valor de CBS ou IBS aprovado para estorno, conforme tpTrib. Presente no Retorno da Solicitação de Estorno." }, "descParecer": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Descrição complementar do parecer da RFB/CGIBS. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Ocorrência respondida pelo órgão competente" ] }, "orientSolic": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Orientação à parte solicitante quanto ao acompanhamento da ocorrência. Presente no Retorno da Solicitação de Estorno.", "examples": [ "Consultar retorno da ocorrência para acompanhamento" ] }, "idAprovEst": { "type": "string", "minLength": 20, "maxLength": 20, "description": "Identificador de aprovação do estorno via MOC, emitido pela RFB ou CGIBS. Corresponde ao número de controle enviado na mensagem de estorno no SPB, conforme o tributo: NumCtrlTESOr para CBS e NumCtrlSTROr para IBS. Preenchimento condicional: retornado somente quando codParecer for 01 (Aceita) ou 02 (Aceita Parcialmente).", "examples": [ "APV20260623000100001" ] } }, "required": [ "nsuId", "arrj", "numCtrlTEF", "idOcor", "dtHrEnvOcor", "dtHrRespOcor", "orgRespRes", "codParecer", "tpTrib", "vlTribEst" ], "allOf": [ { "if": { "properties": { "codParecer": { "enum": [ "01", "02" ] } }, "required": [ "codParecer" ] }, "then": { "required": [ "idAprovEst" ] }, "else": { "not": { "required": [ "idAprovEst" ] } } } ] } }, "responses": { "PPResponseOk": { "description": "PP Recebido", "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Sucesso" ] }, "status": { "type": "integer", "examples": [ 201 ] }, "detail": { "type": "string", "examples": [ "Solicitação processada com sucesso" ] }, "numValidos": { "type": "integer", "examples": [ 997 ] }, "numErros": { "type": "integer", "examples": [ 3 ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 10 ], "description": "Índice (1..n) do item rejeitado na lista enviada, permitindo correlacionar o erro ao item original da requisição." }, "field": { "type": "string", "examples": [ "field1" ] }, "message": { "type": "string", "examples": [ "Campo obrigatório" ] } } } }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseNoContentStreamStart": { "description": "Stream iniciado com sucesso. Nenhuma mensagem disponível dentro da janela de espera do long polling. Não representa falha da operação. No fluxo principal do Retorno Super Inteligente, o 204 (sem corpo) retorna o token de continuação no cabeçalho 'proximoToken' e indica ausência de mensagens no momento: o consumidor deve prosseguir consultando com o proximoToken retornado (não reutilizar o token enviado na requisição).", "headers": { "streamId": { "$ref": "#/components/headers/StreamIdHeader" }, "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseNoContentRetroativoStart": { "description": "A consulta não retornou resultados Na Consulta Retroativa, o 204 (sem corpo) com o último token no header 'proximoToken' indica fim do stream — o consumidor deve encerrar com DELETE.", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseNoContentRetroativoToken": { "description": "Fim do resultado da consulta 204 (sem corpo): na Consulta Retroativa, o retorno do último token no header 'proximoToken' indica fim do stream, exigindo DELETE para encerrar.", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseNoContentStreamToken": { "description": "Nenhuma mensagem disponível dentro da janela de espera do long polling. Não representa falha da operação. No fluxo principal do Retorno Super Inteligente, o 204 (sem corpo) retorna o token de continuação no cabeçalho 'proximoToken' e indica ausência de mensagens no momento: o consumidor deve prosseguir consultando com o proximoToken retornado (não reutilizar o token enviado na requisição).", "headers": { "proximoToken": { "$ref": "#/components/headers/ProximoTokenHeader" }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseGoneStream": { "description": "Stream encerrada. A stream foi encerrada por um DELETE ou automaticamente em função da política de sanitização de streams inativas. O PSP deverá considerar a stream definitivamente extinta e iniciar uma nova stream por meio do endpoint /start. Eventuais mensagens não processadas poderão ser recuperadas por meio da Consulta Retroativa Super Inteligente.", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Gone" ] }, "status": { "type": "integer", "examples": [ 410 ] }, "detail": { "type": "string", "examples": [ "Stream encerrada." ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseGoneRetroativoStream": { "description": "Stream encerrada. A stream foi encerrada por um DELETE ou automaticamente em função da política de sanitização de streams inativas. O PSP deverá considerar a stream definitivamente extinta e, se necessário, iniciar uma nova consulta por meio do endpoint /start.", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Gone" ] }, "status": { "type": "integer", "examples": [ 410 ] }, "detail": { "type": "string", "examples": [ "Stream encerrada." ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseBadRequest": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Bad Request" ] }, "status": { "type": "integer", "examples": [ 400 ] }, "detail": { "type": "string", "examples": [ "Todas as transações do informe estão inválidas" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "examples": [ 1 ], "description": "Índice (1..n) do item rejeitado na lista enviada, permitindo correlacionar o erro ao item original da requisição." }, "field": { "type": "string", "examples": [ "field1" ] }, "message": { "type": "string", "examples": [ "field1: propriedade obrigatória 'field1' não encontrada" ] } } } }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseBadRequestSegregacao": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Bad Request" ] }, "status": { "type": "integer", "examples": [ 400 ] }, "detail": { "type": "string", "examples": [ "Dados do informe de segregacao invalidos" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "examples": [ "idInfSegr" ] }, "message": { "type": "string", "examples": [ "idInfSegr: formato invalido" ] } } } }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseBadRequestConsultaStream": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Bad Request" ] }, "status": { "type": "integer", "examples": [ 400 ] }, "detail": { "type": "string", "examples": [ "Parametros invalidos" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "examples": [ "token" ] }, "message": { "type": "string", "examples": [ "campoX: parametro obrigatorio nao informado" ] } } } }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseUnprocessableEntityConsultaStream": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Unprocessable Entity" ] }, "status": { "type": "integer", "examples": [ 422 ] }, "detail": { "type": "string", "examples": [ "Regras de negocio violadas para consulta de stream", "streamId inexistente", "nsuInicial deve ser menor ou igual a nsuFinal" ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseForbidden": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "example": { "title": "Forbidden", "status": 403, "detail": "Acesso negado", "resourceId": "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" }, "properties": { "title": { "type": "string", "examples": [ "Forbidden" ] }, "status": { "type": "integer", "examples": [ 403 ] }, "detail": { "type": "string", "examples": [ "Todas as transações do informe estão inválidas" ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseError": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "example": { "title": "Internal Server Error", "status": 500, "detail": "Erro interno inesperado", "resourceId": "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" }, "properties": { "title": { "type": "string", "examples": [ "Internal Server Error" ] }, "status": { "type": "integer", "examples": [ 500 ] }, "detail": { "type": "string", "examples": [ "Todas as transações do informe estão inválidas" ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseCreatedSegregacao": { "description": "PP Recebido", "content": { "application/json": { "example": { "title": "PP Recebido", "status": 201, "detail": "Informe de segregação iniciado/finalizado com sucesso", "resourceId": "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" }, "schema": { "$ref": "#/components/responses/PPResponseOk/content/application~1json/schema" } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseCreatedLote": { "description": "Lote criado com sucesso (primeiro envio do idLote).", "content": { "application/json": { "example": { "title": "PP Recebido", "status": 201, "detail": "Lote criado com sucesso", "resourceId": "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" }, "schema": { "$ref": "#/components/responses/PPResponseOk/content/application~1json/schema" } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseOkLote": { "description": "PP Lote Recebido Anteriormente", "content": { "application/json": { "example": { "title": "PP Lote Recebido Anteriormente", "status": 200, "detail": "Lote foi recebido anteriormente", "resourceId": "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" }, "schema": { "$ref": "#/components/responses/PPResponseOk/content/application~1json/schema" } } } }, "PPResponseNoContentMocConsultaStart": { "description": "Consulta realizada com sucesso, porém sem ocorrências disponíveis no momento. O PSP deve aguardar 30 minutos antes de realizar nova consulta, conforme indicado no header 'Retry-After'. Não representa falha.", "headers": { "Retry-After": { "description": "Tempo, em segundos, que o cliente deve aguardar antes de realizar uma nova consulta.", "schema": { "type": "integer", "example": 1800 } }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseNoContentMocConsultaToken": { "description": "Não há mais ocorrências disponíveis no momento. O PSP deve aguardar 30 minutos antes de realizar nova consulta, conforme indicado no header 'Retry-After'. Não representa falha.", "headers": { "Retry-After": { "description": "Tempo, em segundos, que o cliente deve aguardar antes de realizar uma nova consulta.", "schema": { "type": "integer", "example": 1800 } }, "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseBadRequestMocConsulta": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Bad Request" ] }, "status": { "type": "integer", "examples": [ 400 ] }, "detail": { "type": "string", "examples": [ "Parametros invalidos" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "examples": [ "nsuInicial" ] }, "message": { "type": "string", "examples": [ "campoX: parametro obrigatorio nao informado" ] } } } }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseUnprocessableEntityMocConsulta": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Unprocessable Entity" ] }, "status": { "type": "integer", "examples": [ 422 ] }, "detail": { "type": "string", "examples": [ "Regras de negocio violadas para a consulta de ocorrencias do MOC", "proximoToken inexistente ou expirado" ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseUnprocessableEntitySegregacaoIniciada": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Unprocessable Entity" ] }, "status": { "type": "integer", "examples": [ 422 ] }, "detail": { "type": "string", "examples": [ "Regra de negócio violada na abertura do informe de remessa de segregação.", "Já existe uma remessa de segregação iniciada para o idInfSegr informado" ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseUnprocessableEntitySegregacaoLote": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Unprocessable Entity" ] }, "status": { "type": "integer", "examples": [ 422 ] }, "detail": { "type": "string", "examples": [ "Regra de negócio violada no envio do lote de transações da segregação.", "Não existe remessa de segregação iniciada para o idInfSegr informado", "Já existe uma remessa de segregação finalizada para o idInfSegr informado", "O cnpjRaizPspRecDir informado é diferente do cnpjRaizPspRecDir enviado na remessa de segregação iniciada para o idInfSegr informado" ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseUnprocessableEntitySegregacaoFinalizacao": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Unprocessable Entity" ] }, "status": { "type": "integer", "examples": [ 422 ] }, "detail": { "type": "string", "examples": [ "Regra de negócio violada na finalização da remessa de segregação.", "Não existe remessa de segregação iniciada para o idInfSegr informado", "Já existe uma remessa de segregação finalizada para o idInfSegr informado", "O valor informado em totalTrans difere da quantidade de transações enviadas", "O valor informado em vlTotalCbs difere da soma dos valores de CBS das transações enviadas", "O valor informado em vlTotalIbs difere da soma dos valores de IBS das transações enviadas", "O cnpjRaizPspRecDir informado é diferente do cnpjRaizPspRecDir enviado na remessa de segregação iniciada para o idInfSegr informado" ] }, "resourceId": { "type": "string", "examples": [ "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" ] } } } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } }, "PPResponseOkLoteAtualizado": { "description": "Lote atualizado com sucesso (reenvio com o mesmo idLote, substituindo o anterior).", "content": { "application/json": { "example": { "title": "PP Recebido", "status": 200, "detail": "Lote atualizado com sucesso", "resourceId": "UEkBbgR-78VqKK-uvuq9O0r9-bqXyBH9Ur" }, "schema": { "$ref": "#/components/responses/PPResponseOk/content/application~1json/schema" } } }, "headers": { "X-JWS-Signature": { "$ref": "#/components/headers/XJwsSignatureResponseHeader" } } } }, "parameters": { "XJwsSignatureHeaderParam": { "name": "X-JWS-Signature", "in": "header", "required": true, "description": "Header: Assinatura JWS da requisição.", "schema": { "type": "string", "examples": [ "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyIsImtpZCI6IjIwMjYtMDYta2V5LTEiLCJiNjQiOmZhbHNlLCJjcml0IjpbImI2NCJdfQ..dR4M8pVh8kS2b3H1N0aYzQ2vJj5mXw7sK1qP9fL6nE3cU8tI0rB4wD7gF2hL9mN5pQ1sT6uV3xY8zA0bC4dE7w" ] } } }, "headers": { "XJwsSignatureResponseHeader": { "description": "Header: Assinatura JWS da resposta.", "schema": { "type": "string", "example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyIsImtpZCI6IjIwMjYtMDYta2V5LTEiLCJiNjQiOmZhbHNlLCJjcml0IjpbImI2NCJdfQ..dR4M8pVh8kS2b3H1N0aYzQ2vJj5mXw7sK1qP9fL6nE3cU8tI0rB4wD7gF2hL9mN5pQ1sT6uV3xY8zA0bC4dE7w" } }, "ProximoTokenHeader": { "description": "Token de posição da leitura", "schema": { "type": "string", "example": "123232131232132123" } }, "StreamIdHeader": { "description": "Identificador do stream", "schema": { "type": "string", "example": "stream-123232131232132123" } } }, "securitySchemes": { "mutualTLS": { "type": "mutualTLS", "description": "Autenticação mútua TLS (mTLS) com certificado de cliente válido." } } }, "security": [ { "mutualTLS": [] } ] }