/spi/v1/regulatory. Cada mês passa por estes passos:
- Declare os participantes indiretos que você liquida.
POST /regulatory/apix/settled-participantsinicia uma declaração a partir devalidFrom.POST /regulatory/apix/settled-participants/{settled_participant_id}/enda encerra emvalidTo, o último dia em que ela vale. Envie aversionatual da declaração. UmvalidToum dia antes devalidFromanula a declaração. - Registre os fatos que só a sua instituição conhece.
POST /regulatory/apix/facts/{fact_type}registra a versão 1 de um fato.POST /regulatory/apix/facts/{fact_type}/{client_request_id}/correctregistra uma nova versão. A versão anterior permanece. - Feche o mês.
POST /regulatory/apix001/closecongela o relatório de um mês que terminou. - Leia o relatório.
GET /regulatory/apix001/report?period=YYYY-MMdevolve o relatório de um mês fechado. - Altere um mês fechado.
POST /regulatory/apix001/reopenvolta o mês para aberto. Os fatos e as declarações registrados depois do fechamento entram então no próximo fechamento.
X-Idempotency. Os meses estão no horário de America/Sao_Paulo.
Fatos que você registra
fact_type no caminho seleciona o corpo, e o factType do corpo deve ter o mesmo valor. Estes tipos são aceitos:
Qualquer outro tipo é recusado. Cada fato tem um
clientRequestId que você escolhe. O mesmo clientRequestId com o mesmo conteúdo não cria nada e responde o fato já registrado. O mesmo clientRequestId com outro conteúdo é 409 com PIX-0717: corrija o fato. Um novo clientRequestId para um assunto que já tem um fato atual do mesmo tipo é 409 com PIX-0725.
Um fato de um mês fechado é aceito. Ele entra em um relatório somente depois de uma reabertura e de um novo fechamento.
Registrar e corrigir um fato é limitado a 2 chamadas em andamento por tenant em cada instância que atende. Acima desse limite, a chamada responde 429 com PIX-0006 e um header Retry-After, e não registra nada. Envie uma carga retroativa uma chamada por vez.
O fechamento
O fechamento fixa um corte 60 segundos antes de um instante que ele lê do relógio do banco de dados. Um fato, uma correção ou uma declaração que você registra menos de 60 segundos antes da primeira tentativa do fechamento está depois do corte. O relatório o deixa de fora, e ele só conta depois de uma reabertura e de um novo fechamento. Todo reenvio do mesmo fechamento reutiliza o corte.
- Só um mês que terminou pode ser fechado. Um mês futuro é
422comPIX-0710, e o mês atual é422comPIX-0713. - Um mês que já está fechado responde o relatório atual com
200. - Um fechamento que roda com outra chave
X-Idempotencyresponde409comPIX-0712e um headerRetry-After. Envie de novo a mesma requisição depois desse tempo. - Cada instância que atende calcula um fechamento por tenant de cada vez. Quando o espaço está ocupado, a chamada responde
429comPIX-0006e um headerRetry-After.
DATABASE_READ_REPLICA por um pool próprio, com no máximo 4 conexões por pod. Quando DATABASE_READ_REPLICA está vazio, ele lê DATABASE_URL. A réplica deve ser um standby físico do banco de dados do SPI. Um nó que não está em recuperação responde 503 com PIX-0727. Um standby que não aplicou todos os commits até o corte responde 503 com PIX-0715 e um header Retry-After. Nada é congelado, e o mês continua aberto.
O relatório
O relatório tem os dez blocos do layout do APIX001, para o ISPB do seu tenant. Todo bloco e todo indicador carrega
coverage, então um 0.00 que é preenchimento não é um zero medido. Um bloco que o Pix Lerian não calcula volta UNAVAILABLE com um motivo.
Todo outro bloco e todo outro indicador é
UNAVAILABLE.
Um mês que nunca foi fechado, ou que foi reaberto e não foi fechado de novo, responde 404 com PIX-0711.
Permissões
As rotas agem para o tenant inteiro, e nenhuma rota recebe uma conta.
No BYOC, só a declaração de permissões do SPI concede estas permissões: veja Permissões que só a declaração do SPI concede.

