--- title: "Operações com unidades de recebíveis (CERC-AP002). A resposta de cada requisição será enviada como um evento \"unidadeRecebivel\", via Webhook." method: PUT path: "/v15/unidades_recebiveis" tags: ["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 - object[] - `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. - `referenciaExterna` string, 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] - `cnpjCredenciadora` string, 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] - `gestaoGrip` object[] — Dados a serem usados dentro do produto Grip. - `credenciadoraArranjo` string, required — 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.) - `valor` number, required — Valor Constituído da Unidade de Recebível correspondente à Instituição credenciadora do arranjo especificada. - `documentoUsuarioFinalRecebedor` string, 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](https://docs.cerc.com/arranjos-de-pagamento/informacoes-gerais/integracao/referencias-tecnicas-para-operacao?q=/bases_controle/arranjos#dicionario-de-dominios-de-arranjos-de-pagamento). - `dataLiquidacao` string, 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] - `documentoTitular` string — 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] - `valorBrutoTotal` number — Valor total capturado, cuja função é informativa. Não associada a nenhum tipo de ônus relacionado a UR. - `valorConstituidoTotal` number, required — Valor constituído, total, líquido, a pagar pela Instituição Credenciadora ou Subcredenciadora. - `valorConstituidoPreContratado` number, 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. - `valorBloqueado` number — Valor bloqueado para pagamento na unidade de recebível. - `valorTransacaoRiscoUsuarioFinalRecebedorTotal` number — 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. - `valorTransacaoRiscoEmissorTotal` number — 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. - `pagamentos` object[], required - `domicilioPagamento` DomicilioPagamento, required - `numeroDocumentoTitular` string, required — CPF ou CNPJ do titular da conta bancária ou conta de pagamento. Sem formatação. Preenchidos com 0 à esquerda. - `nomeTitular` string — Nome do titular da conta bancária ou conta de pagamento. - `tipoConta` 'CC' | 'CD' | 'CG' | 'CI' | 'PG' | 'PP', required — Tipo de conta onde o pagamento será liquidado: - CC = Conta Corrente - CD - Conta de Depósito - CG - Conta Garantia - CI - Conta Investimento - PG - Conta de Pagamento - PP - Conta Poupança - `compe` string — Código COMPE da Instituição de Domicílio, complementar com 0 à esquerda. - `ispb` string, required — Número do ISPB da Instituição de Domicílio, complementar com 0 a esquerda - `agencia` string, required — Número da Agência para pagamento. - `numeroConta` string, required — Número da conta bancária, quando o tipo de conta for CC, CD, CG, CI ou PP e; Número da conta de pagamento, quando o tipo de conta for PG. Dígito verificador deve ser separado com hífen (ex. 999999-9). Caso não seja informado o hífen a operação será rejeitada. - `valorAPagar` number, required — Valor previsto a ser pago. - `beneficiario` string, required — CNPJ do beneficiário do pagamento. Quando o pagamento for decorrente de um efeito de contrato, utilizar o campo 7.5-Beneficiário/titular do AP008. Se não, deve ser preenchido com o CNPJ do estabelecimento. Sem formatação. Preenchidos com 0 à esquerda. - `dataLiquidacaoEfetiva` string, date — Data do efetivo pagamento, no formato YYYY-MM-DD. Obrigatório em caso de baixa. - `valorLiquidacaoEfetiva` number — Valor final pago pela Instituição Credenciadora ou Subcredenciadora. Obrigatório em caso de baixa. - `motivoDeNaoPagamento` '001' | '002' | '003' | '004' | '999' — Tipo de conta onde o pagamento será liquidado: - 001 = Dados bancários inválidos. - 002 - Liquidação bloqueada. - 003 - Bloqueio judicial; - 004 - Enviar para liquidação CLIQ-HUB/SLC; - 999 - Outros motivos - `identificadorEfeitoContrato` string — Protocolo do efeito de contrato. Correspondente ao campo 7.1 do leiaute AP008. - `formaDePagamento` '1' | '2' | '3' | '4' | '5' | '6' | '7' — Forma de pagamento utilizada na liquidação efetiva da unidade de recebível. Obrigatório quando a informação de pagamento é uma liquidação efetiva. Opções aceitas: - 1 = Transferência entre contas; - 2 = Depósito em conta; - 3 = PIX; - 4 = TED; - 5 = Débito em conta corrente; - 6 = STR; - 7 = SLC/SILOC. - `numeroComprovantePagamento` string — Número de comprovante de pagamento. Regra de preenchimento considerando o tipo informado no campo Forma de Pagamento: - Para os tipos = 1,2,3,4,5 ou 6, preencher com o Número de Controle de Pagamento utilizado na liquidação; - Para o tipo = 7, preencher com o Número Único de Liquidação retornado pelo SLC. Obrigatório quando formaDePagamento = 1,2,3,4,5 ou 6, ou quando tipoOperacao = L. Não informar caso formaDePagamento = 7 operando via Hub AP. ## Response `207` 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. - object[] - `protocolo` string — GUID ID de Protocolo gerado pela CERC, confirmando o recebimento da requisição - `referenciaExterna` string — Código de referência de controle do participante, para identificação nas próximas consultas relacionadas - `dataHoraProcessamento` string, 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. - `erros` Erro[] - `codigo` string — Código do erro - Consultar Tabela de Erro - `mensagem` string — Descrição do erro - Consultar Tabela de Erro ## Other responses - `400` — Tabela de Erros |CÓDIGO|DESCRIÇÃO | |------|-----------------------------------------------------------------------------| |102001|TIPO DE OPERACAO OBRIGATORIO | |102002|TIPO DE OPERACAO INVALIDO | |102003|REFERENCIA EXTERNA OBRIGATORIA | |102004|REFERENCIA EXTERNA INVALIDA | |102005|INSTITUICAO CREDENCIADORA OU SUBCREDENCIADORA PARTICIPANTE OBRIGATORIA | |102006|CNPJ DA INSTITUICAO CREDENCIADORA OU SUBCREDENCIADORA PARTICIPANTE INVALIDO | |102007|CNPJ DA INSTITUICAO CREDENCIADORA DO ARRANJO INVALIDO | |102008|USUARIO FINAL RECEBEDOR OBRIGATORIO | |102009|CPF OU CNPJ DO USUARIO FINAL RECEBEDOR INVALIDO | |102010|USUARIO FINAL RECEBEDOR NAO CADASTRADO | |102011|ARRANJO DE PAGAMENTO OBRIGATORIO | |102012|ARRANJO DE PAGAMENTO INVALIDO | |102013|DATA DE LIQUIDACAO OBRIGATORIA | |102014|DATA DE LIQUIDACAO INVALIDA | |102015|CPF OU CNPJ DO TITULAR INVALIDO | |102016|VALOR BRUTO TOTAL INVALIDO | |102017|VALOR CONSTITUIDO TOTAL OBRIGATORIO | |102018|VALOR CONSTITUIDO TOTAL INVALIDO | |102019|VALOR CONSTITUIDO PRE CONTRATADO OBRIGATORIO | |102020|VALOR CONSTITUIDO PRE CONTRATADO INVALIDO | |102021|VALOR CONSTITUIDO PRE-CONTRATADO NAO PODE SER SUPERIOR AO VALOR CONSTITUIDO | |102022|VALOR BLOQUEADO INVALIDO | |102023|VALOR TRANSACAO RISCO USUARIO FINAL RECEBEDOR TOTAL INVALIDO | |102024|VALOR TRANSACAO RISCO EMISSOR TOTAL INVALIDO | |102025|NUMERO DOCUMENTO TITULAR DOMICILIO OBRIGATORIO | |102026|NUMERO DOCUMENTO TITULAR DOMICILIO INVALIDO | |102027|TIPO DE CONTA OBRIGATORIO | |102028|TIPO DE CONTA INVALIDO | |102029|COMPE INVALIDO | |102030|ISPB OBRIGATORIO | |102031|ISPB INVALIDO | |102032|AGENCIA OBRIGATORIA | |102033|AGENCIA INVALIDA | |102034|NUMERO DA CONTA OBRIGATORIA | |102035|NUMERO DA CONTA INVALIDA | |102036|VALOR A PAGAR INVALIDO | |102037|CNPJ DO BENEFICIARIO INVALIDO | |102038|DATA LIQUIDACAO EFETIVA OBRIGATORIA | |102039|DATA LIQUIDACAO EFETIVA INVALIDA | |102040|VALOR LIQUIDACAO EFETIVA OBRIGATORIO | |102041|VALOR LIQUIDACAO EFETIVA INVALIDO | |102042|MOTIVO DE NAO PAGAMENTO INVALIDO | |102043|USUARIO FINAL RECEBEDOR NAO POSSUI VINCULO COM A INSTITUICAO CREDENCIADORA | |102044|FALTA DE CONEXAO OPERACIONAL ATIVA DA IC COM ENTIDADES REGISTRADORAS | |102045|DOMICILIO DE PAGAMENTO OBRIGATORIO | |102046|IDENTIFICADOR DO EFEITO DE CONTRATO INVALIDO | |102047|VALOR CONSTITUIDO UNIDADE RECEBIVEL OBRIGATORIO | |102048|VALOR CONSTITUIDO UNIDADE RECEBIVEL INVALIDO | |102049|CNPJ INSTITUICAO CREDENCIADORA ARRANJO OBRIGATORIO | |102050|VALOR A PAGAR OBRIGATORIO | |102051|VALOR A PAGAR DEVE SER MAIOR QUE ZERO | |102052|DOCUMENTO DO BENEFICIARIO OBRIGATORIO | |102053|IDENTIFICADOR DO EFEITO DE CONTRATO OBRIGATORIO | |102054|IDENTIFICADOR DO EFEITO DE CONTRATO INVALIDO | |102801|OPERACAO NAO PERMITIDA - ACESSO NEGADO | |102802|OPERACAO INVALIDA PARA O REGISTRO ATUAL | |102803|UNIDADE DE RECEBIVEL JA REGISTRADA | |102804|ERRO DEVIDO A ATUALIZACAO DE CAMPOS NAO PERMITIDOS | |102805|ERRO GENERICO DE VALIDACAO | |102806|INSTITUICAO CREDENCIADORA REGISTRADA EM INSTITUICAO DIFERENTE DA INFORMADA | |102807|UNIDADE DE RECEBIVEL REGISTRADA EM OUTRA REGISTRADORA | |102808|REJEICAO DE UR POR RESTRICAO DE GRADE HORARIA | |102810|UNIDADE RECEBIVEL COM DUPLICIDADE | |102811|OPERACAO DO TIPO BAIXA SEM LIQUIDACAO | |102812|NAO E POSSIVEL ATUALIZAR UMA UNIDADE RECEBIVEL JA BAIXADA | |102813|REFERENCIA EXTERNA NAO PODE SER ATUALIZADA | |102901|LAYOUT INVALIDO | |102903|NOME DO ARQUIVO JA ENVIADO | |102904|NOME DO ARQUIVO INVALIDO | |102905|VALOR A PAGAR OBRIGATORIO | |102907|VALOR BRUTO TOTAL NAO PODE SER INFERIOR AO VALOR CONSTITUIDO TOTAL | |102908|DATA DE LIQUIDACAO EM UR DE DEBITO NAO PODE SER SUPERIOR A 45 DIAS | |102909|DATA DE LIQUIDACAO EM UR DE CREDITO NAO PODE SER SUPERIOR A 5 ANOS | |102910|VALOR LIQUIDACAO EFETIVA DEVE SER MAIOR QUE ZERO | |102911|DATA DE LIQUIDACAO EFETIVA NAO PODE SER SUPERIOR A 15 DIAS | |102912|VALOR LIQUIDACAO EFETIVA MAIOR QUE ZERO POREM SEM POS-CONTRATADA REGISTRADA | |102913|TITULAR DIFERENTE DO UFR POREM SEM CONTRATO DE TROCA DE TITULARIDADE OU CESSAO| |102914|BENEFICIARIO OBRIGATORIO | |102915|IDENTIFICADOR DO EFEITO DE CONTRATO OBRIGATORIO QUANDO BENEFICIARIO DIFERENTE DO UFR| |102916|VALOR CONSTITUIDO MAIOR QUE ZERO E VALOR BLOQUEADO MENOR - VALOR A PAGAR DEVE SER MAIOR QUE ZERO| |102917|PARA LIQUIDACAO PARCIAL A DATA DE LIQUIDACAO EFETIVA NAO PODE SER MAIOR QUE HOJE| |102918|OPERACAO INVALIDA EM UMA UR JA INATIVA OU BAIXADA COM DATA DE LIQUIDACAO ANTERIOR A 90 DIAS| |102919|VALOR CONSTITUIDO PRE-CONTRATADO MAIOR QUE ZERO POREM SEM PRE-CONTRATADA REGISTRADA| |102920|FORMA DE PAGAMENTO OBRIGATORIO | |102921|FORMA DE PAGAMENTO INVALIDO | |102922|NUMERO DE CONTROLE DE PAGAMENTO OBRIGATORIO | |102923|NUMERO DE CONTROLE DE PAGAMENTO INVALIDO | |102924|NUMERO DE CONTROLE DE PAGAMENTO INFORMADO INDEVIDAMENTE PARA LIQUIDACAO SLC EM PARTICIPANTE COM HUB AP| |102925|ATUALIZACAO DE CAMPO INDEVIDO EM OPERACAO DE CONFIRMACAO DE LIQUIDACAO | |102926|OPERACAO DE CONFIRMACAO DE LIQUIDACAO SO PODE SER FEITA EM UR BAIXADA | |102998|FORA DA JANELA DE PROCESSAMENTO | |102999|ERRO INESPERADO | --- [API](https://skmtc.net/cerc/apis/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d.md) · [All operations](https://skmtc.net/cerc/apis/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cerc/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d/revisions/98997c37ec38/schema)