Skip to main content

Payload de Pagamentos

Pagamento confirmado

Os webhooks de Pagamento Externo Confirmado (Pix Out) enviam objetos com os seguintes campos no seu payload:

  • payment: Objeto com detalhes do Pagamento
  • transaction: Objeto com detalhes da Transação Pix

Exemplo

{
"event": "OPENPIX:MOVEMENT_CONFIRMED",
"payment": {
"value": 30,
"status": "CONFIRMED",
"destinationAlias": "06882328684",
"comment": "",
"correlationID": "222a1750-de17-406c-bd0c-25af9a5a5d08"
},
"transaction": {
"value": 30,
"endToEndId": "E23114447202303161242u80lZNR7nQZ",
"time": "2023-03-16T12:42:47.526Z"
}
}

Falha no pagamento

Os webhooks de Pagamento Externo com Falha (Pix Out) enviam objetos com os seguintes campos no seu payload:

  • payment: Objeto com detalhes do Pagamento
  • transaction: Objeto com detalhes da Transação Pix se ela existir
  • error: Objeto com o código e descrição do motivo da falha.
info

Veja mais detalhes sobre erros relacionados a um Pagamento externo na documentação

Exemplo

{
"event": "OPENPIX:MOVEMENT_FAILED",
"payment": {
"value": 30,
"status": "FAILED",
"destinationAlias": "06882328684",
"comment": "",
"correlationID": "222a1750-de17-406c-bd0c-25af9a5a5d08"
},
"transaction": {
"value": 30,
"endToEndId": "E23114447202303161242u80lZNR7nQZ",
"time": "2023-03-16T12:42:47.526Z"
},
"error": {
"code":"PAY_PIX_KEY_ERROR",
"description":"Falha ao Pagar Chave Pix"
}
}

Pagamento removido

Os webhooks de Pagamento Externo Removido (Pix Out) enviam objetos com os seguintes campos no seu payload:

  • payment: Objeto com o correlationID do pagamento removido
{
"event": "OPENPIX:MOVEMENT_REMOVED",
"payment": {
"correlationID": "222a1750-de17-406c-bd0c-25af9a5a5d08"
}
}