Notificações
Nossas APIs usam webhooks para notificações de eventos. Webhooks são chamadas push API que permitem que seu aplicativo saiba que um evento aconteceu.
Para receber notificações sobre os eventos da sua plataforma, você deve configurar previamente a notificação quando realizar POST
a transação, indicando a URL no campo callback
.
Evento
Sempre que ocorrer um evento, enviaremos uma notificação no formato json usando HTTP POST para o URL que você especificou.
Cada mensagem de notificação POST no formato JSON contém informações de evento com base no tipo de recurso e no tipo de evento.
Observação: se seu aplicativo responder com qualquer outro código de status, tentaremos reenviar a mensagem de notificação 5 vezes ao longo de três dias.
Segurança - Para evitar ataques de downgrade
Cada notificação que enviamos para seu endpoint é assinada. Fazemos isso incluindo um cabeçalho nomeado "Jump-Signature"
em cada evento que enviamos. Isso permite que você verifique e garanta que o evento foi enviado pelo SmartFastPay e não por um terceiro.
Exemplo de notificação
Um exemplo de uma notificação de pagamento bem-sucedida :
Notificação de Cash In
{
"requestId": "456oc8d8-13e0-4db8-92b5-8dc54a433a97",
"data": [
{
"id": "456oc8d8-13e0-4db8-92b5-8dc54a433a97",
"customer_id": "2985746",
"transaction_id": "193846",
"amount": "213.21",
"status": "paid",
"type": "payment",
"payment_status": "paid",
"exchange": "5.52"
}
]
}
Detalhes dos dados de notificação
id
A transação criada pela solicitação criou um identificador único.
customer_id
O ID do cliente armazenado em sua plataforma para identificação futura.
transaction_id
O id da transação gerada na sua plataforma.
amount
O valor que o cliente especificou ao iniciar a transação
status
O status atual da transação. Estes são nossos status: paid
,canceled
type
Mostra o tipo desta transação. payment
oupayout
payment_status
O status atual do pagamento. Estes são nossos status: paid
, denied
,expired
exchange
A taxa de câmbio aplicada à transação atual
Notificação de Cash Out
{
"requestId": "398oca92-13e0-9db8-93b5-1dc24a323a97",
"data": [
{
"id": "398oca92-13e0-9db8-93b5-1dc24a323a97",
"customer_id": "2985746",
"transaction_id": "193846",
"amount": "398.45",
"status": "canceled",
"type": "payout",
"payout_status": "failed",
"exchange": "5.52"
}
]
}
Detalhes dos dados de notificação
id
A transação criada pela solicitação criou um identificador único.
customer_id
O ID do cliente armazenado em sua plataforma para identificação futura.
transaction_id
O id da transação gerada na sua plataforma.
amount
O valor que o cliente especificou ao iniciar a transação
status
O status atual da transação. Estes são nossos status: paid
,canceled
type
Mostra o tipo desta transação. payment
oupayout
payment_status
O status atual do pagamento. Estes são nossos status: paid
, denied
,expired
exchange
A taxa de câmbio aplicada à transação atual
Atualizado
Isto foi útil?