Pacote SMS
Fluxo de Funcionamento da API
Figura 1. Fluxo do pacote SMS
1.
2.
3.
José, transação aprovada no valor de R$ 100 em seu CARTAO HORIZON PAY.
4.
5.
O emissor pode oferecer diferentes serviços SMS para os portadores. Dentre eles:
Código | Descrição |
---|---|
1 | TRANSACAO_APROVADA |
2 | PAGAMENTO_PROCESSADO |
3 | CODIGO_BARRAS_FATURA_AUTOMATICO |
4 | CODIGO_BARRAS_FATURA_SOLICITACAO |
5 | CARTAO_ENVIADO |
6 | SEGUNDA_VIA_SENHA_CARTAO_SOLICITACAO |
7 | SAQUE |
8 | CARTAO_TAC_IMPRESSO |
9 | BOAS_VINDAS_AO_PORTADOR |
10 | CODIGO_BARRAS_BOLETO_ACORDO_SOLICITACAO |
11 | ENVIAR_SENHA_DE_CARTAO_POR_DESBLOQUEIO |
12 | ALERTA_FATURA_DISPONIVEL |
13 | ENVIO_SENHA_MODULO_CLIENTE |
14 | ENVIAR_PROTOCOLO_SMS_AUTOMATICO |
15 | ENVIAR_PROTOCOLO_SMS_SOLICITACAO |
16 | ENVIAR_SENHA_NO_EMBOSSING_CARTAO |
17 | ENVIAR_SENHA_AO_VINCULAR_NONAME |
19 | ENVIAR_SENHA_DE_CARTAO_CAPANA |
20 | ENVIAR_SENHA_DE_CARTAO_GERACAO_ALEATORIA |
Endpoints
Tipo | Endpoint | Descriçã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-sms | Consultar pacotes do portador |
PATCH | /api/v1/pacotes-sms/portador/{idPortador}/telefones/sms/adesao | Habilitar celular para adesão do pacote |
GET | /api/v1/pacotes-sms/portador/{idPortador}/telefones/bonus | Habilitar celular para receber bônus |
GET | /api/v1/pacotes-sms/contratos/disponiveis | Consultar pacotes disponíveis |
GET | /api/v1/pacotes-sms/contratados | Consultar pacotes contratados |
Casos de uso
Contratar um pacote SMS
Exemplo de requisição:
idPortador
: 2001 para realizar a contratação com esse portador.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
Exemplo de requisição:
idPortador
: 2001 para realizar o cancelamento com esse portador.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
Exemplo de requisição:
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.