Error - Payload

Em casos onde uma transação via Pix não é concluída com sucesso, a Fire enviará um payload de erro via webhook para a URL configurada pelo cliente.

Esse payload contém as informações da transação que falhou.

Estrutura de Payload

{
  "transactionId": "a05766b1-8ec8-4c9a-bc7c-0540da68fbf6",
  "businessTransactionId": null,
  "status": "ERROR",
  "value": 458,
  "endToEndId": "E303852592025022520564567631635e",
  "pixKey": null,
  "createdDate": "2025-02-25T20:57:02.058Z"
}

Descrição dos Campos

Campo	Tipo	Descrição
`transactionId`	`string`	Identificador único da transação gerado pela FireBanking.
`businessTransactionId`	`string`	(Opcional) Identificador da transação fornecido pelo cliente.
`status`	`string`	Status atual da transação. Exemplo: `ERROR` indica que a transação falhou.
`value`	`number`	Valor da transação em centavos.
`endToEndId`	`string`	Identificador único do pagamento Pix gerado pelo sistema bancário.
`pixKey`	`string`	(Opcional) Chave Pix que deveria ser utilizada, mas está `null` em caso de erro.
`createdDate`	`string`	Data e hora em que a transação foi criada, no formato ISO 8601.