v1

latestOpenAPI 3.1.12026-07-2371254470.9 KB
Opt-in/out

Informar permissão de acesso à agenda por meio de opt-in (CERC-AP004)

post/opt_in

Request body

tipoOperacao'C' | 'A' required

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

  • C = Criar;
  • A = Atualizar;
referenciaExternastring required

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

cnpjSolicitantestring required

CNPJ do solicitante. 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]

cnpjFinanciadorstring required

CNPJ do financiador ou não financeira autorizado. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.

dataAssinaturaOptInstring date required

Data em que foi concedida a autorização pelo Usuário Final Recebedor, no formato AAAA-MM-DD.

carteirastring

Código da carteira à qual o contrato pertence. Caso o campo não seja informado será utilizada a carteira padrão do participante. Obrigatório e atualizável caso a empresa seja do tipo "Prestador de Serviço".

protocolostring

Protocolo de retorno recebido na criação do opt-in.

Response

Dados do sucesso da operação

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.
All 71 operations