Aparência
Notificações push (aplicativo)
Toda notificação salva para o usuário (a lista de Notificações do app e do portal, GET access/auth/notifications) também é enviada por push aos aparelhos dele, pelo serviço de push do Expo. Cada usuário escolhe quais tipos quer receber por push; a lista de notificações continua com todas.
Todas as rotas exigem Authorization: Bearer {token}.
Tipos de notificação
type | Quando | Quem recebe | Abre no app |
|---|---|---|---|
payment_received | Entrada de dinheiro: Pix, BolePix, boleto ou transferência recebida (não taxas nem saídas) | Usuários da conta com view_extract ou view_transactions | /transacoes/{id} |
charge_paid | Cobrança passa para paga, por qualquer caminho (webhook do banco, simulação, conciliação) | Usuários da conta com view_charges | /cobrancas/{id} |
export_ready | Exportação de transações concluída (ou sem resultado) | Quem pediu a exportação | /notificacoes |
other | Qualquer outra notificação salva no banco, inclusive as criadas no futuro | O destinatário da notificação | /notificacoes |
As notificações de dinheiro recebido e cobrança paga são criadas só depois do commit da transação: se o pagamento for desfeito, ninguém é avisado. Uma falha ao notificar nunca interrompe o pagamento.
Registrar o aparelho
POST /access/auth/push-tokens
json
{ "token": "ExponentPushToken[xxxxxxxxxxxxxxxxxxxxxx]", "platform": "ios", "device_name": "iPhone de Maria" }token(obrigatório): token do Expo (ExponentPushToken[...]ouExpoPushToken[...]).platform(opcional):ios,androidouweb.- Um token pertence a um único usuário: registrar o mesmo aparelho com outro login passa o token para o novo usuário.
Resposta 201: { "message": "Aparelho registrado para notificações.", "data": { "id": 1 } }
Remover o aparelho (ao sair)
DELETE /access/auth/push-tokens com { "token": "ExponentPushToken[...]" } → 200.
Tokens que o Expo informa como inexistentes (DeviceNotRegistered) são removidos automaticamente.
Preferências
GET /access/auth/notification-preferences
json
{
"data": [
{ "type": "payment_received", "label": "Dinheiro recebido", "description": "Pix, BolePix, boleto e transferências que entram na conta.", "push": true },
{ "type": "charge_paid", "label": "Cobrança paga", "description": "Quando um cliente paga uma cobrança.", "push": true },
{ "type": "export_ready", "label": "Exportação pronta", "description": "Arquivo de transações pronto para baixar.", "push": true },
{ "type": "other", "label": "Outros avisos", "description": "Demais avisos da conta.", "push": true }
]
}Sem escolha salva, todos os tipos ficam ligados.
PUT /access/auth/notification-preferences
json
{ "preferences": { "charge_paid": false } }Envie só os tipos que mudaram. Tipo desconhecido → 422. A resposta traz a lista atualizada.
Mensagem enviada ao aparelho
json
{
"to": "ExponentPushToken[...]",
"title": "Pix recebido",
"body": "Você recebeu R$ 150,50 na conta Exemplo Comércio Ltda.",
"data": { "type": "payment_received", "notification_id": "uuid", "url": "/transacoes/123", "account_id": 1, "transaction_id": 123, "value": 150.5 },
"badge": 3,
"sound": "default",
"channelId": "default"
}badge é a quantidade de notificações não lidas do usuário. O app usa data.url para abrir a tela e data.account_id para trocar para a conta certa.
Configuração
EXPO_ACCESS_TOKEN(opcional): exigido só se a opção Enhanced security for push notifications estiver ligada no projeto do Expo.- O envio é feito pela fila (
SendPushNotificationJob, 3 tentativas): o worker de filas precisa estar rodando.