Cash In - Payload

Quando uma transação de pagamento via Pix é concluída com sucesso, a FireBanking envia o seguinte payload via webhook para a URL previamente configurada por você.

Este payload contém as informações detalhadas da transação Pix, incluindo dados do pagador e do recebedor.

Estrutura de Payload

{
  "transactionId": "03cadd36-fddd-4091-9ffe-67b0483cbcf5",
  "businessTransactionId": null,
  "status": "PAID",
  "value": 1,
  "endToEndId": "XPTO",
  "pixKey": "XYZ",
  "createdDate": "2025-02-25T22:22:49.198Z",
  "ReceiverBankAccount": "0000",
  "ReceiverToBankAccountDigit": "0",
  "ReceiverBankBranch": "0000",
  "ReceiverBankCode": "0",
  "ReceiverDocumentNumber": "45438750000188",
  "ReceiverBankName": "",
  "ReceiverBankISPB": "0",
  "ReceiverName": "FIRE INTERMEDIAÇÃO DE PAGAMENTOS LTDA",
  "PayerBankAccount": "0000",
  "PayerBankAccountDigit": "0",
  "PayerBankBranch": "0000",
  "PayerBankCode": "000",
  "PayerDocumentNumber": "0000000000",
  "PayerBankName": "PICPAY INSTITUIçãO DE PAGAMENTO S.A.",
  "PayerBankISPB": "22896431",
  "PayerName": "NOME",
  "VoucherUrl": ""
}

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: `PAID` indica que a retirada foi paga.
`value`	`number`	Valor da transação em centavos.
`endToEndId`	`string`	Identificador único do pagamento Pix gerado pelo sistema bancário.
`pixKey`	`string`	Chave Pix utilizada para enviar o pagamento.
`createdDate`	`string`	Data e hora em que a transação foi criada, no formato ISO 8601.
`ReceiverBankAccount`	`string`	Número da conta bancária do recebedor do Pix.
`ReceiverToBankAccountDigit`	`string`	Dígito verificador da conta bancária do recebedor.
`ReceiverBankBranch`	`string`	Número da agência bancária do recebedor.
`ReceiverBankCode`	`string`	Código do banco recebedor (Código de compensação bancária).
`ReceiverDocumentNumber`	`string`	Número do documento do recebedor (CNPJ ou CPF).
`ReceiverBankName`	`string`	Nome do banco recebedor.
`ReceiverBankISPB`	`string`	Código ISPB do banco recebedor.
`ReceiverName`	`string`	Nome completo ou razão social do recebedor.
`PayerBankAccount`	`string`	Número da conta bancária do pagador.
`PayerBankAccountDigit`	`string`	Dígito verificador da conta bancária do pagador.
`PayerBankBranch`	`string`	Número da agência bancária do pagador.
`PayerBankCode`	`string`	Código do banco pagador (Código de compensação bancária).
`PayerDocumentNumber`	`string`	Número do documento do pagador (CNPJ ou CPF).
`PayerBankName`	`string`	Nome do banco pagador.
`PayerBankISPB`	`string`	Código ISPB do banco pagador.
`PayerName`	`string`	Nome completo do pagador.
`VoucherUrl`	`string`	(Opcional) URL do comprovante de pagamento Pix.

Referente aos status em que a transação pode ter, quando retomado via webhook

ERROR: Algum erro foi gerado e a transação não foi concluída.
PAID: Transação paga com sucesso (Cash In).
REFUND_IN: Valor reembolsado, se houve devolução.