v1

latestOpenAPI 3.1.12026-07-2371254470.9 KB

Registro e atualização de unidades de recebíveis

Operações com unidades de recebíveis (CERC-AP002). A resposta de cada requisição será enviada como um evento "unidadeRecebivel", via Webhook.

put/v15/unidades_recebiveis

Request body

tipoOperacao'C' | 'A' | 'I' | 'B' | 'L' required

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

C = Criar registro;
A = Atualizar registro;
I = Inativar;
B = Baixar;
L = Confirmação de liquidação.

referenciaExternastring required

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

cnpjCredenciadorastring 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]

documentoUsuarioFinalRecebedorstring required

CNPJ ou CPF do Usuário Final Recebedor. 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]

valorBrutoTotalnumber

Valor total capturado, cuja função é informativa. Não associada a nenhum tipo de ônus relacionado a UR.

valorConstituidoTotalnumber required

Valor constituído, total, líquido, a pagar pela Instituição Credenciadora ou Subcredenciadora.

valorConstituidoPreContratadonumber required

Valor constituído, líquido, a pagar pela Instituição Credenciadora ou Subcredenciadora, com prazo inferior ao máximo do Arranjo de Pagamento, se houver.

valorBloqueadonumber

Valor bloqueado para pagamento na unidade de recebível.

valorTransacaoRiscoUsuarioFinalRecebedorTotalnumber

O valor capturado em transações cuja responsabilidade pela fraude for do Usuário Final Recebedor, total, líquido, em reais, a pagar pela Instituição Credenciadora ou Subcredenciadora, devendo ser zero caso não haja valor constituído na categoria.

valorTransacaoRiscoEmissorTotalnumber

O valor capturado em transações cuja responsabilidade pela fraude for do emissor do cartão, total, líquido, em reais, a pagar pela Instituição Credenciadora ou Subcredenciadora, devendo ser zero ccaso não haja valor constituído na categoria.

Response

Registro de Unidades de Recebiveis recebido, será enviado um webhook da operação para a URL cadastrada do participante uma vez que a UR for processada,necessário consultar individualmente cada item para obter o status de processamento.

protocolostring

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

referenciaExternastring

Código de referência de controle do participante, para identificação nas próximas consultas relacionadas

dataHoraProcessamentostring date-time

Data/hora da requisição

status'0' | '1'

Tipo de conta onde o pagamento será liquidado:

0 = Pedido processado com sucesso.
1 = Pedido processado com erro.