Tote
HomeAPIsGuiasRelease Notes
HomeAPIsGuiasRelease Notes
Fale conosco
  1. APIs
  • Diretrizes Básicas
  • Autenticação
    • Autenticação
  • Acheron
    • Pagamento
      • Cadastrar um pagamento
      • Cancelar um pagamento
      • Criar intenção de pagamento
      • Confirmar intenção de pagamento
      • Cancelar intenção de pagamento
      • Listar intenções de pagamento
      • Criar pagamento via PIX
    • Venda
      • Criar venda com cartão
      • Cancelar venda com cartão
      • Criar venda com portador
      • Cancelar venda com portador
      • Estornar uma venda
    • E-Commerce
      • Criar venda e-commerce
      • Confirmar pagamento e-commerce
      • Listar pagamento e-commerce
      • Cancelar venda e-commerce
      • Gerar token de e-commerce
    • VTEX
      • Criar venda VTEX
      • Confirmar venda VTEX
      • Estornar venda VTEX
      • Cancelar venda VTEX
      • Listar manifesto do provedor de pagamento
    • Simulação
      • Criar simulação
    • Pré-autorização
      • Listar pré-autorização
      • Cancelar valor reservado
      • Listar valor reservado
    • BNPL
      • Confirmar estorno de venda
      • Estornar venda
      • Simular venda
      • Confirmar venda
      • Sensibilizar venda
  • Agenda lojista
    • Agenda
      • Cadastrar recebimento em agenda
      • Cadastrar agenda manual
      • Listar agenda por loja
      • Consultar agenda específica
      • Listar transações pelo ID da agenda ou loja
    • Configurações de Agendas
      • Cadastrar configuração
      • Listar configurações da agenda
      • Alterar configuração de uma loja
    • Modalidade
      • Cadastrar modalidades
      • Listar modalidades
      • Listar modalidade por lançamento
      • Alterar tipo de modalidade
    • Lançamentos
      • Listar lançamentos por loja
      • Cadastrar lançamentos
      • Cadastrar lançamento de ajuste
    • Tipo de ajuste
      • Cadastrar um tipo de ajuste
      • Listar tipo de ajuste
  • Banking
    • Conciliação bancária
      • Gerar saldo para um emissor
      • Gerar extrato para um emissor
      • Gerar arquivos de conciliação
    • Contas
      • Listar contas digitais
    • Pix
      • Transferir pix
      • Listar status do pix
      • Listar transferências Pix
      • Listar informações de chave
  • Biometria
    • Biometria
    • Handshake fortface
      • Iniciar o processo de autenticação biométrica SDK
      • Iniciar o processo de autenticação biométrica Backoffice
    • Biometria
      • Identificar um rosto
      • Cadastrar uma face utilizando o SDK Fortface
      • Cadastrar uma face através do Backoffice da Fortface
  • Broker
    • Enviar mensagem SMS
  • Cartões
    • Portadores
      • Buscar cartão pelo titular
      • Cadastrar portador adicional
      • Listar cartões do adicional
      • Gerar cartão adicional
    • CVV Virtual
      • Ativar CVV Virtual do titular
      • Inativar CVV Virtual
      • Atualizar data de expiração do CVV
    • Senha
      • Cadastrar senha
      • Alterar senha
      • Autenticar senha do cartão
      • Gerar senha e enviar por SMS
    • Bloqueios e Desbloqueios
      • Bloquear um cartão temporariamente
      • Bloquear permanentemente
      • Listar histórico de bloqueios
      • Listar tipos de bloqueio
      • Desbloquear cartão
    • Cartões
      • Solicitar segunda via
      • Trocar cartão pendente
      • Buscar cartão criptografado
      • Listar histórico de cancelamento
      • Listar tipos de cancelamento
      • Gerar um cartão virtual
      • Listar cartão virtual
      • Buscar cartão pelo id
      • Buscar cartão pelo número
      • Buscar cartão pelo CPF
      • Buscar cartão bandeirado
      • Token Merci
      • Trocar cartão do portador
      • Cadastrar Pessoa Jurídica
      • Solicitar troca do cartão
      • Listar BIN
    • No Name
      • Listar lotes de cartão
      • Criar lote de cartões
      • Destruir cartão
      • Vincular cartão ao titular
      • Vincular cartão adicional
      • Destruir lote de cartões
      • Embossar cartões por lote
      • Listar cartões
    • Vipagem
      • Listar cartões bandeirados
      • Emitir segunda via
  • Embossing
    • Cartões
      • Embossing de cartão
      • Bloquear cartão por falha
      • Listar cartões pendentes
    • Impressoras
      • Inativar impressora
      • Ativar impressora
  • Empréstimo
    • Empréstimo Pix Card
      • Enviar arquivo
      • Alterar dados bancários
      • Transferir via Pix
      • Cadastrar pessoa física
      • Simular empréstimo
      • Confirmar empréstimo
      • Aprovar crédito
      • Criar contrato
      • Consultar pessoa
    • Empréstimo FGTS
      • Simular saldo
      • Obter saldo
      • Cadastrar pessoa física
      • Cadastrar operação
      • Submeter para aprovação
      • Consultar informações
      • Listar produto
      • Consultar pessoa
      • Listar operações
      • Acompanhar operação
      • Listar estado civil
      • Listar bancos
  • Faturamentos
    • Parcelamento de fatura
      • Antecipar uma parcela do parcelamento
      • Antecipar todo o parcelamento
      • Buscar parcelamento pendente
      • Buscar parcelamento ativo
      • Simular antecipação
      • Parcelar faturas
    • Ciclos de fatura
      • Consultar ciclos de vencimento
      • Alterar o ciclo de vencimento
    • Consulta de faturas
      • Consultar lançamentos futuros
      • Consultar faturas por período
      • Consultar faturas futuras
      • Consultar última fatura fechada
      • Consultar fatura detalhada
      • Consultar fatura atual
      • Visualizar saldo detalhado
    • Faturas digitais
      • Receber fatura em PDF
      • Aderir à fatura digital
      • Cancelar fatura digital
      • Aderir à fatura por SMS
      • Cancelar fatura por SMS
  • Financiamentos
    • Parcelamento total
      • Simular parcelamento devedor total
    • Parcelamento manual
      • Simular parcelamento manual
  • Gestão de contas
    • Cadastrar cartão físico para titular
  • Lançamentos
    • Ajustes
      • Lançar um ajuste financeiro
      • Listar um ajuste financeiro
      • Lançar ajustes a débito
      • Lançar ajustes a crédito
      • Listar tipos de ajustes
      • Listar faturas ajustadas
      • Lançar um ajuste na fatura
    • Vendas
      • Antecipar venda total
      • Antecipar venda avulsa
    • Pagamentos
    • Antecipação
      • Listar compras passíveis de antecipação
    • Baixas bancárias
      • Estornar lançamento de baixa bancária
      • Lançar baixa báncaria
      • Lançar baixa bancária de pagamento
      • Estornar pagamento de baixa bancária
  • Loja
    • Formas de Pagamentos
      • Listar formas de pagamento
      • Cadastrar forma de pagamento
      • Atualizar forma de pagamento
      • Consultar parcelas de uma loja
    • Tarifas
      • Listar tarifas
      • Cadastrar tarifa
      • Associar tarifa a uma loja
      • Cancelar tarifas com a loja
      • Listar tarifas por loja
      • Consultar uma tarifa
      • Alterar cadastro de uma tarifa
    • Lojas
      • Cadastrar uma loja
      • Consultar uma loja
      • Consultar loja por id externo
      • Listar loja pelo CNPJ
      • Listar lojas
      • Alterar uma loja
  • Pacote SMS
    • Contratar um pacote SMS
    • Cancelar um pacote SMS
    • Consultar pacotes do portador
    • Habilitar celular para adesão do pacote
    • Habilitar celular para receber bônus
    • Consultar pacotes disponíveis
    • Consultar pacotes contratados
  • Parâmetros
    • Listar parâmetros cadastrados
    • Listar parâmetros exibíveis
  • Pix
    • Pix Imediato
      • Listar chaves Pix Imediato
      • Gerar Pix Imediato
      • Listar uma chave Pix Imediato
  • Pix Card
    • PixCard
      • Transferir via Pix
      • Consultar CPF
      • Cadastrar cliente
      • Simular operação
      • Confirmar operação
      • Cadastrar documento do portador
    • Assinatura
      • Listar as assinaturas
      • Cadastrar assinatura
      • Verificar assinaturas para cobrança
      • Listar assinaturas válidas
      • Listar planos
      • Alterar assinatura pelo CPF
    • Conta Digital
      • Listar termos obrigatórios
      • Cadastrar termo obrigatório
      • Cadastrar documento do portador
      • Criar uma conta digital
      • Criar uma conta alias
      • Listar contas pelo identificador
      • Listar informações do portador
    • Transferência
      • Agendar transferência
      • Efetuar transferência
      • Listar status de transferência
      • Listar devoluções
      • Listar transferências
      • Listar agendamentos de transferências
    • Relatórios
      • Listar operações
      • Listar relatórios de assinaturas
      • Listar adesões
    • QR Code
      • Criar QR Code estático
      • Decodificar QR Code
    • Chaves
      • Confirmar reivindicações
      • Fazer reivindicação
      • Cadastrar chave
      • Deletar chave
      • Listar chaves
      • Consultar chaves pelo identificador
      • Listar reivindicações
    • Limites
      • Criar limite de horário
      • Associar conta a grupo de serviço
      • Listar destinos confiáveis
      • Alterar limite do destino confiável
      • Listar limites de horários
      • Listar requisições
      • Remover destino confiável
  • Portadores
    • Gestão de portadores
      • Listar status do portador pelo CPF
      • Listar portadores
      • Alterar dados do portador
      • Alterar status de ativo problemático
      • Listar informações do portador
      • Alterar o limite do portador
      • Bloquear um portador
      • Desbloquear um portador
      • Listar adicionais pelo CPF
      • Listar portadores em lote
      • Listar contas pelo CPF (simplificado)
      • Listar contas pelo CNPJ
      • Alterar produto do portador
      • Listar contas pelo documento
      • Listar contas pelo RG
      • Listar contas pelo nome
      • Alterar vipagem
      • Consultar ciclo do portador
      • Listar contas pelo CPF (completo)
    • Gestão de dependentes
      • Listar dependentes pelo titular
      • Cadastrar dependentes
    • Gestão de telefones
      • Listar telefones
      • Cadastrar telefone
      • Deletar telefone
      • Receber SMS
    • Visualização de histórico
      • Listar histórico do portador
      • Listar ocorrências
      • Listar inadimplências pelo portador
      • Listar o histórico de limites
    • Gestão de senhas
      • Enviar senha por SMS
      • Alterar senha do portador
    • Cadastro de contas
      • Cadastrar uma conta PJ
      • Cadastrar uma conta PF
    • Informações da base de dados
      • Listar tipos de bloqueio
      • Listar escolaridades
      • Listar ocupações
    • BNPL
      • Consultar informações do portador
  • Portuno
    • Conta
      • Listar conta
      • Criar uma conta
      • Trocar o segredo da conta
    • Integração
      • Listar integrações
      • Alterar tempo de expiração de uma integração
  • Produtos
    • Produtos
      • Consultar produtos
      • Consultar um produto
    • Serviços financeiros
      • Listar serviços financeiros
  • Recompensa
    • Aderir à anuidade bonificada
    • Cancelar anuidade bonificada
    • Listar anuidades do produto
    • Listar anuidade do portador
    • Listar anuidades
    • Listar as anuidades
    • Cadastrar anuidades
  • Regulatório
    • Listar informações
  • Seguros
    • Seguros
      • Cancelar adesão do titular
      • Aderir seguro para o titular
      • Aderir seguro para dependente
      • Cancelar adesão do dependente
      • Listar seguros de dependentes
      • Listar seguros disponíveis
      • Cancelar um seguro
      • Listar seguros do portador
      • Listar campos de adesão ao seguro
      • Listar campos de adesão do portador
      • Listar seguros cancelados
    • Bilhetes de Seguro
      • Listar bilhetes de um portador
      • Listar o modelo de operação
      • Listar um bilhete de adesão
    • Cobranças e Pagamentos
      • Fazer estímulo de cobrança
    • Termos da Adesão
      • Listar termos de adesão
      • Listar modelos do código de operação
      • Listar termos de um seguro
  • Serviços Bancários
    • Registrar um boleto online
    • Listar pagamentos
    • Listar boleto completo
    • Listar contas habilitadas
  • SMS Notice
    • Processamento
      • Listar os eventos
      • Criar um evento
      • Alterar um evento
      • Listar as variáveis
      • Criar variáveis
      • Listar as transações
      • Criar mensagem para fila
    • Serviços
      • Criar um serviço de SMS
      • Listar serviços cadastrados
      • Alterar um serviço de SMS
      • Listar um serviço específico
    • Pacote de SMS
      • Listar os pacotes de sms
      • Cadastrar pacote SMS
      • Listar um pacote específico
      • Alterar um pacote específico
      • Aderir a um pacote SMS
      • Cancelar uma adesão
      • Listar adesões de um portador
      • Alterar o telefone do pacote
  1. APIs

Pacote SMS

A API Pacote SMS permite o envio de mensagens SMS automáticas para portadores com base em eventos específicos.
Atua como um gateway para gerenciar requisições de pacotes de mensagens SMS, padronizando a comunicação com a processadora Cards. Ele garante a integração segura, o controle eficiente e a rastreabilidade das operações, facilitando a gestão e conformidade com os requisitos técnicos.

Fluxo de Funcionamento da API#

pacote-sms
Figura 1. Fluxo do pacote SMS
1.
Identificação do Evento
Um evento ocorre no sistema (exemplo: TRANSACAO_APROVADA).
O sistema verifica se o evento está associado a um serviço de notificação.
2.
Verificação do Tipo de Serviço
Se for um serviço padrão, a mensagem correspondente é preparada para envio automaticamente.
Se for um serviço não padrão, o sistema verifica se o portador contratou o pacote de SMS correspondente.
Caso o serviço não seja contratado, a notificação não será enviada.
3.
Montagem da Mensagem
O sistema gera a mensagem pré-definida associada ao evento, por exemplo:
José, transação aprovada no valor de R$ 100 em seu CARTAO HORIZON PAY.
A mensagem é formatada de acordo com as regras definidas para cada tipo de serviço.
4.
Envio via Broker Service
A API chama o broker service, responsável por realizar o envio do SMS.
O broker confirma o envio da mensagem e retorna um status de sucesso ou erro.
5.
Registro e Monitoramento
O sistema registra a tentativa de envio da mensagem e o status retornado pelo broker.
Em caso de falha, pode haver reenvio dependendo da política definida para o serviço.

O emissor pode oferecer diferentes serviços SMS para os portadores. Dentre eles:#

CódigoDescrição
1TRANSACAO_APROVADA
2PAGAMENTO_PROCESSADO
3CODIGO_BARRAS_FATURA_AUTOMATICO
4CODIGO_BARRAS_FATURA_SOLICITACAO
5CARTAO_ENVIADO
6SEGUNDA_VIA_SENHA_CARTAO_SOLICITACAO
7SAQUE
8CARTAO_TAC_IMPRESSO
9BOAS_VINDAS_AO_PORTADOR
10CODIGO_BARRAS_BOLETO_ACORDO_SOLICITACAO
11ENVIAR_SENHA_DE_CARTAO_POR_DESBLOQUEIO
12ALERTA_FATURA_DISPONIVEL
13ENVIO_SENHA_MODULO_CLIENTE
14ENVIAR_PROTOCOLO_SMS_AUTOMATICO
15ENVIAR_PROTOCOLO_SMS_SOLICITACAO
16ENVIAR_SENHA_NO_EMBOSSING_CARTAO
17ENVIAR_SENHA_AO_VINCULAR_NONAME
19ENVIAR_SENHA_DE_CARTAO_CAPANA
20ENVIAR_SENHA_DE_CARTAO_GERACAO_ALEATORIA

Endpoints#

TipoEndpointDescrição
POST/api/v1/pacotes-sms/{idPortador}Contratar um pacote SMS
DELETE/api/v1/pacotes-sms/{idPortador}Cancelar um pacote SMS
GET/api/v1/pacotes-smsConsultar pacotes do portador
PATCH/api/v1/pacotes-sms/portador/{idPortador}/telefones/sms/adesaoHabilitar celular para adesão do pacote
GET/api/v1/pacotes-sms/portador/{idPortador}/telefones/bonusHabilitar celular para receber bônus
GET/api/v1/pacotes-sms/contratos/disponiveisConsultar pacotes disponíveis
GET/api/v1/pacotes-sms/contratadosConsultar pacotes contratados

Casos de uso#

A seguir, detalhamos os principais casos de uso na Jornada de Pacote SMS, explicando como cada operação é realizada através das API
Contratar um pacote SMS
Use este endpoint para realizar a contratação do pacote de SMS para o portador.

Exemplo de requisição:#

Use o Path parameter idPortador: 2001 para realizar a contratação com esse portador.
Use o Query parameter idPacoteSms: -22 para identificar o pacote de SMS contratado.

Exemplo de response:#


 {
  "httpStatus": "OK",
  "mensagens": [
    "Contratação de pacote SMS efetuada com sucesso."
  ]
}
Cancelar um pacote SMS
Use este endpoint para realizar o cancelamento de um pacote SMS.

Exemplo de requisição:#

Use o Path parameter idPortador: 2001 para realizar o cancelamento com esse portador.
Use o Query parameter idPacoteSms: -22 para identificar o pacote de SMS cancelado.

Exemplo de response:#


 {
  "httpStatus": "OK",
  "mensagens": [
    "Cancelamento da contratação de pacote SMS efetuada com sucesso."
  ]
}
Consultar pacotes do portador
Use este endpoint para realizar a consulta de um pacote SMS.

Exemplo de requisição:#

Use Path parameter idPortador: 2001 para realizar a consulta com esse portador.

Exemplo de response:#


 {
  "pacoteSmsResponse": [
    {
      "servicosInclusos": [
        {
          "nome": "Transação Aprovada",
          "id": 1,
          "descricao": "Ao aprovar uma transação o sistema enviará um SMS ao portador do cartão, informando-o sobre a operação realizada."
        },
        {
          "nome": "Pagamento Processado",
          "id": 2,
          "descricao": "Ao processar um novo pagamento o sistema enviará um SMS ao portador do cartão, confirmando o recebimento do pagamento."
        },
        {
          "nome": "Código de Barras da Fatura [Automático]",
          "id": 3,
          "descricao": "Ao gerar fatura, o sistema enviará um SMS ao portador, informando dados da fatura gerada incluindo a linha digitável para pagamento da mesma."
        },
        {
          "nome": "Saque",
          "id": 7,
          "descricao": "Ao aprovar uma transação de saque, o sistema enviará um SMS ao portador do cartão, informando-o sobre a operação realizada."
        },
        {
          "nome": "Alerta Fatura disponivel",
          "id": 12,
          "descricao": "Ao gerar fatura, o sistema enviara um SMS ao portador, informando a disponibilidade da mesma. Obs: O alerta funciona para faturas bancarias e nao bancarias."
        }
      ],
      "contratado": false,
      "nome": "PACOTE SERVICOS SMS",
      "valorTarifa": 80,
      "id": 2001,
      "descricao": "descrição pacote SMS",
      "status": "A"
    },
    {
      "servicosInclusos": [
        {
          "nome": "Serviço teste",
          "id": 20,
          "descricao": "Descrição do serviço teste"
        }
      ],
      "contratado": true,
      "nome": "PACOTE SERVICOS SMS II",
      "valorTarifa": 73.15,
      "id": 2002,
      "descricao": "descrição pacote SMS",
      "status": "A"
    }
  ]
}

Os endpoints irão retornar os dados que podem ser acessados de acordo com suas credenciais de autenticação. Para mais informações, visite a página de autenticação.

Serviços relacionados#

API Pacote SMS

Materiais relacionados#

Como testar endpoints através do Tote
Diretrizes básicas do Horizon
Respostas e possíveis erros

Clique no botão abaixo para nos contar o que achou da nova plataforma. Você será redirecionado para um formulário rápido.
Enviar feedback
Página anterior
Alterar uma loja
Próxima página
Contratar um pacote SMS