API Campanhas

A API de Campanhas é responsável por toda a gestão do ciclo de vida de campanhas promocionais da Elo, atuando como camada central de orquestração entre emissores, portadores e sistemas internos.

Por meio desta API é possível:

• Consultar campanhas disponíveis para um emissor.
• Verificar a elegibilidade de portadores por BIN, CPF ou CNPJ.
• Registrar adesão (opt-in) e cancelamento (opt-out) em campanhas.
• Adicionar e gerenciar cartões vinculados à participação em campanhas.
• Consultar cupons gerados e informações de sorteios.
• Consultar ganhadores de campanhas.

Grupos de Endpoints

A API possui dois grupos distintos de endpoints, atendendo diferentes cenários de integração.

Endpoints Externos

Destinados aos emissores integrados por meio do Portal do Desenvolvedor.

• Prefixo: /v1/campaigns
• Autenticação: OAuth 2.0 Client Credentials

Esses endpoints utilizam o contexto do emissor identificado pela claim org_id presente no token de acesso.

Endpoints Internos

Destinados a aplicações e sistemas internos da Elo que operam no contexto de um portador autenticado.

• Prefixo: /v1/internal
• Autenticação: OAuth 2.0 Token Exchange

Nesses endpoints, o usuário é identificado automaticamente pela claim cardholder:user_id presente no JWT, não sendo necessário informar o identificador do portador nas requisições.