2.2 Opt-in e Opt-out

Para que seja possível visualizar a Agenda de Recebíveis de um Estabelecimento Comercial, é necessário informar a Anuência para a Plataforma TAG, processo também conhecido como Opt-in.

Já o Opt-out seria a interrupção de um Opt-in, realizado pelo próprio Credor quando não deseja mais visualizar as agendas do Estabelecimento Comercial

Testando os cenários utilizando Massa de Testes

O time de Integração irá encaminhar algumas agendas para seus testes utilizando CNPJs não atribuídos aleatórios. Neste e-mail devem estar contidos, os seguintes dados:

• Originador (originalAssetHolder)
• Credenciadora (acquirer)
• Arranjo de Pagamento (paymentScheme)
• Datas das URs

Utilize esses dados como alvos de seus Contratos, Opt-ins e Opt-outs. Caso não tenha recebido este e-mail, contate nosso time de Integração e solicite a criação da massa de dados para testes.

Para a execução dos testes de Opt-in e Opt-out, você deverá enviar, através do endpoint correspondente, as informações corretamente preenchidas.

📘

Dica

Sempre guarde os resultados de resposta. Dados como a processKey, key e Status Code são importantes para o seguimento dos testes e investigação de possíveis problemas encontrados.

Envio de Opt-in

Acesse a referência da API - Opt-in para visualizar os exemplos de arquivo JSON. No cenário ideal, espera-se um status code de resposta 202 (accepted).

Caso o Opt-in tenha sido registrado com sucesso, você agora estará apto a verificar as agendas selecionadas. Assim, você poderá realizar a Consulta de Agenda por Titular (para mais, consultar capítulo 2.3 dessa seção).

Realização de Opt-out

Acesse a referência da API - Opt-out para uma melhor experiência.

A chamada do EndPoint de Opt-out deve conter a chave de identificação (key) previamente enviada no processo de Opt-in. A chave deve ser especificada no caminho de atualização (PATCH).

Alteração de Data de Vigência do Opt-in

Acesse a referência da API - Alteração de Data de Vigência para visualizar os exemplos de arquivo JSON.

A chamada do EndPoint de Alteração de Data de Vigência deve conter a chave de identificação (key) previamente enviada no processo de Opt-in alvo. A chave deve ser especificada no caminho de atualização (PATCH).

Consulta

Existem duas formas de Realizar a Consulta de Optin:

• Consulta por Chave
• Consulta por Parâmetros

Consulta de Notificação

Após efetuar alguma operação de POST (criação) ou PATCH (alteração) referente à Opt-in, será gerada uma Notificação Assíncrona de Anuência (eventType = consent). Caso não tenha um Webhook para receber essa notificação, ela poderá ser consultada através do Endpoint de Consulta de Notificação de Opt-in.

🚧

To-dos de Desenvolvimento

1. Ler a documentação e entender os conceitos abaixo:
   1. Registro de Recebíveis de Arranjo de Pagamento;
   2. Unidade de Recebíveis (UR);
   3. Agenda de Recebíveis;
   4. Anuência para recebimento da Agenda de Recebíveis;
2. Desenvolver a integração com o serviço Opt-in;
3. Realizar a Consulta dos Opt-ins Realizados;
4. Desenvolver a integração com o serviço Opt-out;
5. Realizar a Consulta do Opt-in que sofreu Opt-out e identificar o que foi alterado;
6. Desenvolver a Integração com o serviço Alteração de Data de Vigência;
7. Realizar a Consulta do Opt-in que sofreu Alteração da Data de Vigência e identificar o que foi alterado.