Skip to main content
Quando uma transação de pagamento via Pix é concluída com sucesso, a Pagou 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 do Payload

Payload
{
  "transactionId": "df4b72ac-c49a-47dc-bd15-855f3d418949",
  "businessTransactionId": "0000000000000000000",
  "status": "WAITING_PAYMENT",
  "value": 10000,
  "endToEndId": null,
  "pixKey": "0000000000000000000",
  "createdDate": "2025-07-15T21:22:16.501Z",
  "ReceiverBankAccount": "0000",
  "ReceiverToBankAccountDigit": "0",
  "ReceiverBankBranch": "0000",
  "ReceiverBankCode": "000",
  "ReceiverDocumentNumber": "000000000000000",
  "ReceiverBankName": "PAGOU AI",
  "ReceiverBankISPB": "0000000",
  "ReceiverName": "VENDEDOR",
  "PayerBankAccount": "0000",
  "PayerBankAccountDigit": "0",
  "PayerBankBranch": "0000",
  "PayerBankCode": "0000",
  "PayerDocumentNumber": "00000000000000",
  "PayerBankName": "BANCO",
  "PayerBankISPB": "00000000",
  "PayerName": "NOME",
  "VoucherUrl": ""
}

​
Descrição dos Campos

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

​
Status possíveis da transação

Valor reembolsado, se houve devolução.
Algum erro foi gerado e a transação não foi concluída.