Com webhooks você pode inscrever uma URL da sua aplicação que esteja disponível para a internet, para receber notificações referentes a mudanças de status de pagamento na Transfeera.
Todos os eventos são enviados através de uma requisição HTTP/HTTPS POST com o formato JSON no payload.
Seu endpoint precisa retornar um status code de sucesso na resposta, sendo (2xx) um formato válido, assim consideraremos como entregue. Caso contrário, vamos retentar entregar a notificação mais 2 vezes, depois disso, não vamos mais tentar entregar a notificação deste evento.
O exemplo abaixo é um exemplo de um payload de evento que enviamos.
{
{
"id": "7d3aae40-6655-4d9a-801b-d0ab7ae906d7", // ID do evento
"version": "v1", // Versão do schema do evento
"object": "Validation", // Tipo do objeto do evento (Opções disponíveis: Validation)
"date": "2019-10-01T17:54:39.000Z", // Data e hora do evento
"data": { // Payload do evento
"id": "8f9d9bb5-119e-4da8-bd50-3418d227c1d6", // ID da validação
"integration_id": null, // Integration ID (Caso disponível)
"micro_deposit_status": "VALIDADO", // Status da validação
"micro_deposit_value": null, // Valor do micro depósito informado no request da validação (Caso tenha sido informado um valor)
"micro_deposit_method": "TRANSFERENCIA", // TRANSFERENCIA ou PIX, método utilizado para realizar o micro depósito
"valid": true, // Indica se a conta é válida, caso seja null a validação ainda não foi finalizada
"errors": [], // Lista de erros caso exista algum (Ver seção de erros)
"receipt_url": null, // URL do recibo da Transfeera (Caso disponível)
"bank_receipt_url": null, // URL do recibo do banco (Caso disponível)
"pix_description": null, // Descrição informada no pagamento Pix da validação
"source": "API", // API ou APP - indica a origem da validaçao se foi realizada pela API ou pela interface (APP)
"created_at": "2019-10-25T17:33:56.000Z", // Data de criação da validação
"person_type": "natural_person", // Tipo da pessoa titular da conta
"person_type_details": { // Detalhes da pessoa (apenas para contas habilitadas)
"natural_person": {
"is_under_age": false
}
}
}
}