Gatilho de notificação de atualização da transação Pix
Os endpoints de Criação de Cobrança e Solicitação de Saque aceitam um parâmetro callbackUrl, utilizado para envio de notificações automáticas sempre que o status da transação for atualizado.
Como funciona?
Sempre que o status de uma transação for alterado, a API envia uma requisição HTTP POST para o callbackUrl informado. O corpo da requisição contém os dados atualizados da transação em formato JSON.
A URL deve estar acessível publicamente e preparada para processar requisições com o header:
Content-Type: application/jsonCampos enviados
| Parâmetro | Descrição | Tipo |
|---|---|---|
| id | Identificador único da transação no sistema | string |
| status | Status atual da transação | Status |
| amount | Valor da transação em reais | decimal |
| type | Tipo da transação, DEPOSIT ou WITHDRAW | string |
| qrCodeText | Código Copia e Cola do PIX para pagamento | string |
| qrCodeBase64 | Imagem do QR Code codificada em base64 | string |
| qrCodeUrl | URL para a imagem do QR Code PIX | string |
| generatedName | Nome usado como referência na transação. | string |
| generatedDocument | CPF ou CNPJ vinculado à transação | string |
| generatedEmail | E-mail associado à transação | string |
| payerName | Nome do pagador (Se houver pagador) | string |
| payerDocument | Documento do pagador (Se houver pagador) | string |
| payerInstitutionIspb | ISPB da instituição do pagador | string |
| payerInstitutionName | Nome da instituição do pagador | string |
| serviceFeeCharged | Valor da taxa de serviço cobrada | decimal |
| withdrawPixKey | Chave Pix para saque (se houver) | string |
| withdrawPixType | Tipo da chave Pix | PixKey |
| receiverName | Nome do recebedor (se fornecido) | string |
| receiverDocument | Documento do recebedor (se fornecido) | string |
| receiverInstitutionIspb | ISPB da instituição do recebedor | string |
| receiverInstitutionName | Nome da instituição do recebedor | string |
| endToEndId | ID EndToEnd | string |
| createdAt | Data de criação da transação | string |
| updatedAt | Data de atualização da transação | string |
| paidAt | Data e hora em que a transação foi paga (pode ser nula se ainda não foi paga) | string |
| infraction | Informações da infração (retornado apenas em caso de infração) | Infractions? |