v1

latestOpenAPI 3.1.12026-07-2371254470.9 KB

Informação e atualização de antecipações pós-contratadas

Operações envolvendo antecipações pós-contratadas (CERC-AP003)

put/pos_contratadas

Request body

tipoOperacao'C' | 'A' | 'B' required

Identifica o tipo de operação correspondente àquela entrada, sendo::

C = Criar;
A = Atualizar;
B = Baixar.

referenciaExternastring required

Código de referência único (exclusivo) de controle do participante, para identificação nas transações futuras. [Não atualizável]

instituicaoCredenciadorastring required

CNPJ da instituição credenciadora ou subcredenciadora participante. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário. [Não atualizável]

instituicaoCredenciadoraDoArranjostring

CNPJ Identificador da Instituição Credenciadora que tem relação direta com o instituidor do arranjo. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário. [Não atualizável]

documentoUsuarioFinalRecebedorstring required

CPF ou CNPJ do usuário final recebedor, titular da conta bancária ou da conta de pagamento. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário. [Não atualizável]

codigoArranjoPagamento'ACC' | 'BCC' | 'BCD' | 'CBC' | 'CBD' | 'ECC' | 'ECD' | 'GCC' | 'HCC' | 'JCC' | 'MCC' | 'MCD' | 'OCD' | 'SCC' | 'SCD' | 'VCC' | 'VCD' | 'VDC' | 'HCD' | 'SIC' | 'BRS' | 'MAC' | 'CUP' | 'CZC' | 'FRC' | 'MXC' | 'SFC' | 'TKC' | 'BNC' | 'CCD' | 'BRC' | 'SPC' | 'CSC' | 'DAC' | 'DCC' | 'AGC' | 'AUC' | 'RCC' | 'AVC' | 'DBC' required

Código constante da tabela vigente neste manual. Para obter a lista atualizada na base de controle do ambiente de Interoperabilidade, consulte o Dicionário de domínios de arranjos de pagamento.

dataLiquidacaostring date required

Data de liquidação do recebível prevista pelo arranjo de pagamento ou com os efeitos de pré-contratada, no formato AAAA-MM-DD. [Não atualizável]

documentoTitularstring

CNPJ ou CPF do Titular da UR. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário. [Não atualizável]

dataContratadaAntecipacaostring date required

Data prevista para realização do pagamento referente à pós-contratada ao usuário final recebedor, no formato AAAA-MM-DD.

valorAntecipadonumber required

Valor final a ser pago pela instituição credenciadora ou subcredenciadora, em reais.

valorConstituidoAntecipadonumber required

Valor total, sem desconto, que foi antecipado pela instituição credenciadora ou subcredenciadora. Valor em reais.

identificadorOperacaostring

Identificador da operação pós-contratada. Podendo englobar mais de uma unidade de recebível.

Response

Processamento de pós-contradas realizado. Necessário consultar individualmente cada item para obter o status de processamento.

referenciaExternastring required

Código de referência único (exclusivo), de controle do participante, para identificação nas próximas consultas relacionadas.

protocolostring required

GUID ID de Protocolo gerado pela CERC, confirmando o recebimento da requisição.

dataHoraProcessamentostring date-time required

Data/hora da requisição

statusstring required

Código 0 em caso de sucesso