Avisos e relatórios
Tudo o que acontece com uma cobrança vira um evento. Os eventos podem ser lidos pela API ou recebidos no seu sistema por webhooks.
Rotas
| Rota | ||
|---|---|---|
GET |
/events |
tudo que aconteceu |
GET / POST |
/webhook-endpoints |
endereços de aviso |
GET |
/analytics/overview |
resumo do período (?start=&end=) |
POST |
/reconciliation-runs |
conferir um período |
Endereço de aviso de um bot
Um endereço pode ouvir só as cobranças criadas por uma chave: mande only_source com key: e o id da chave. Assim cada bot da empresa recebe apenas o que é dele.
curl https://api.suypay.com/v1/webhook-endpoints \
-H "Authorization: Bearer suy_live_..." \
-H "Content-Type: application/json" \
-d '{ "url": "https://meubot.com/suypay", "events": ["payment.succeeded"], "only_source": "key:key_..." }'
Conferir um período
Veja Conferência para o que é comparado e como rodar fora do horário.