De tempos em tempos, um dos terminais da Adyen encontram um problema ou precisam realizar manutenção. Quando isso acontece, o terminal gera uma notificação de evento. Você pode opcionalmente apresentar esta notificação em sua caixa registradora para informar a equipe da loja sobre a disponibilidade e o estado do terminal.
Aqui descrevemos como você expõe um endpoint no servidor e configura notificações de eventos. Seu servidor receberá webhooks que incluem um EventToNotify. Isso indica o estado do terminal e pode ser usado para apresentar uma mensagem na sua caixa registradora.
Também fornecemos uma lista de tipos de EventToNotify possíveis e exemplos de cada um.
Configurar notificações de eventos
Etapa 1: Expor um endpoint em seu servidor
As notificações de eventos são enviadas como HTTP callbacks (webhooks) para um endpoint no seu servidor. Para receber notificações, verifique se você possui um servidor com:
- Um endpoint que pode receber uma chamada JSON.
- Uma porta TCP aberta para tráfego HTTP (443, 8443 ou 8843).
Para teste, você também pode usar uma porta HTTP (80, 8080 ou 8888).
- Um nome de usuário e senha para autenticação básica.
Etapa 2: Configurar notificações na sua área de cliente
O próximo passo é inserir os detalhes do seu servidor na sua Área do Cliente e selecionar informações adicionais que você deseja receber nas notificações. Você pode configurar as notificações no nível de company account ou merchant account.
- Faça login em sua Customer Area. Para configurar notificações no nível de merchant accoout, mude para o nível de conta desejada.
- Vá para Developers > Webhooks e selecione + Webhook.
- Não lado de Terminal API details, selecione Add.
- Na seção Transport:
- Digite o URL do servidos. Verifique se é um URL public.
- Digita a SSL (TLS) Version do seu servidor.
- Marque a caixa de seleção como Active.
- Na seção Authentication, digite o nome de usuário e a senha do servidor para autenticação básica.
Incluímos esses detalhes no cabeçalho da solicitação de notificação para autenticação no seu servidor. - Na seção Additional settings, ative Event notification.
- Selecione Test Configuration e verifique se a notificação foi recebida no seu terminal.
- Se o seu terminal recebeu a notificação, selecione Save Configuration.
Agora, as notificações de eventos serão enviadas para o terminal especificado.
Tipos de notificação de eventos
Cada notificação contém um EventToNotify. Você pode usar isso para apresentar uma mensagem na sua caixa registradora informando a equipe da loja sobre o estado do terminal.
| Evento | Descrição |
|---|---|
Shutdown |
O terminal está desligando. |
BeginMaintenance |
O terminal está desligando. |
EndMaintenance |
A manutenção do terminal está terminanda. |
OutOfOrder |
O terminal está inacessível. |
Initialised |
O terminal foi inicializado e está pronto para as transações. |
Reject |
Uma solicitação foi rejeitada. Uma explicação do erro deve ser fornecida no elemento EventDetails. |
SaleWakeUp |
O terminal está iniciando uma solicitação de pagamento. O elemento EventDetails contém o número de referência que foi inserido no terminal. |
Exemplos de notificações de eventos são fornecidos abaixo.
Exemplos
Shutdown
{
"SaleToPOIRequest":{
"EventNotification":{
"EventDetails":"newstate=IDLE&oldstate=START",
"EventToNotify":"Shutdown",
"TimeStamp":"2019-08-07T10:16:10.000Z"
},
"MessageHeader":{
"SaleID":"POSSystemID12345",
"ProtocolVersion":"3.0",
"MessageType":"Notification",
"POIID":"V400m-324688179",
"MessageClass":"Event",
"MessageCategory":"Event",
"DeviceID":"1517998561"
}
}
}BeginMaintenance
{
"SaleToPOIRequest":{
"EventNotification":{
"EventDetails":"newstate=IDLE&oldstate=START",
"EventToNotify":"BeginMaintenance",
"TimeStamp":"2019-08-07T10:16:10.000Z"
},
"MessageHeader":{
"SaleID":"POSSystemID12345",
"ProtocolVersion":"3.0",
"MessageType":"Notification",
"POIID":"V400m-324688179",
"MessageClass":"Event",
"MessageCategory":"Event",
"DeviceID":"1517998562"
}
}
}EndMaintenance
{
"SaleToPOIRequest":{
"EventNotification":{
"EventDetails":"newstate=IDLE&oldstate=START",
"EventToNotify":"EndMaintenance",
"TimeStamp":"2019-08-07T10:16:10.000Z"
},
"MessageHeader":{
"SaleID":"POSSystemID12345",
"ProtocolVersion":"3.0",
"MessageType":"Notification",
"POIID":"V400m-324688179",
"MessageClass":"Event",
"MessageCategory":"Event",
"DeviceID":"1517998561"
}
}
}OutOfOrder
{
"SaleToPOIRequest":{
"EventNotification":{
"EventDetails":"newstate=IDLE&oldstate=START",
"EventToNotify":"OutOfOrder",
"TimeStamp":"2019-08-07T10:16:10.000Z"
},
"MessageHeader":{
"SaleID":"POSSystemID12345",
"ProtocolVersion":"3.0",
"MessageType":"Notification",
"POIID":"V400m-324688179",
"MessageClass":"Event",
"MessageCategory":"Event",
"DeviceID":"1517998563"
}
}
}Initialised
{
"SaleToPOIRequest":{
"EventNotification":{
"EventDetails":"newstate=IDLE&oldstate=START",
"EventToNotify":"Initialised",
"TimeStamp":"2019-08-07T10:16:10.000Z"
},
"MessageHeader":{
"SaleID":"POSSystemID12345",
"ProtocolVersion":"3.0",
"MessageType":"Notification",
"POIID":"V400m-324688179",
"MessageClass":"Event",
"MessageCategory":"Event",
"DeviceID":"1517998564"
}
}
}Reject
{
"SaleToPOIRequest":{
"EventNotification":{
"EventDetails":"newstate=IDLE&oldstate=START",
"EventToNotify":"Reject",
"TimeStamp":"2019-08-07T10:16:10.000Z"
},
"MessageHeader":{
"SaleID":"POSSystemID12345",
"ProtocolVersion":"3.0",
"MessageType":"Notification",
"POIID":"V400m-324688179",
"MessageClass":"Event",
"MessageCategory":"Event",
"DeviceID":"1517998565"
}
}
}SaleWakeUp
{
"SaleToPOIRequest":{
"EventNotification":{
"EventDetails":"0123456789",
"EventToNotify":"SaleWakeUp",
"TimeStamp":"2019-11-15T10:16:10.000Z"
},
"MessageHeader":{
"SaleID":"POSSystemID12345",
"ProtocolVersion":"3.0",
"MessageType":"Notification",
"POIID":"V400m-324688179",
"MessageClass":"Event",
"MessageCategory":"Event",
"DeviceID":"1517998561"
}
}
}