v1

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

Suspender permissão de acesso à agenda por meio de opt-out (CERC-AP006)

post/opt_out

Request body

referenciaExternastring required

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

protocoloOptInstring required

Retorno do Processamento da Operação de OPT-IN

cnpjSolicitantestring required

CNPJ do solicitante do Opt-out. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.

carteirastring

Código da carteira à qual o contrato pertence. Caso o campo não seja informado será utilizada a carteira padrão do participante.

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.