PAYED) e a cada devolução ao pagador: PARTIALLY_REFUNDED enquanto a soma das devoluções não chega ao valor do PIX e REFUNDED na devolução que completa (veja Devoluções no webhook).
| Campo | Tipo | Descrição |
|---|---|---|
event | string | Sempre PIX_IN_UPDATE |
method | string | Sempre PIX_IN |
status | string | PAYED, PARTIALLY_REFUNDED ou REFUNDED |
transactionId | string | ID da transação no Alpha Gateway |
idempotency | string | Chave de idempotência enviada na criação |
payer | object | Dados do pagador (quando disponível) |
payer.fullname | string | Nome do pagador |
payer.document | string | CPF ou CNPJ do pagador |
pix | object | Detalhes do PIX |
pix.endToEndId | string | Identificador end-to-end do PIX |
pix.txid | string | ID da transação PIX |
pix.value | string | Valor pago |
pix.devolutions | array | Sempre vazio no pagamento (mantido por compatibilidade); as devoluções vêm em devolutions no evento REFUNDED |
refundedAmount | number | Total devolvido ao pagador até esta devolução (apenas nas devoluções) |
devolutionSummary | object | Resumo: originalAmount (valor do PIX), refundedAmount (devolvido), pendingAmount (sempre 0 na cobrança) e remainingAmount (o que falta devolver) (apenas nas devoluções) |
devolutions | array | Todas as devoluções do PIX até esta, em ordem (apenas nas devoluções) |
partial | boolean | true em devolução parcial; false na que completa o valor (apenas nas devoluções) |
devolution | object | A devolução que gerou este evento: id, endToEndId, amount, refundedAt e medRefund (apenas nas devoluções) |
devolution.medRefund | boolean | true quando a devolução é o reembolso de uma infração (MED PIX) já resolvida com reembolso: o valor já tinha saído do seu saldo pela infração, então não desconte de novo |
devolutions[].id | string | ID da devolução no Alpha Gateway |
devolutions[].endToEndId | string | Identificador end-to-end da devolução |
devolutions[].amount | number | Valor devolvido nesta devolução |
devolutions[].refundedAt | string | Data e hora da devolução (ISO 8601) |
{
"event": "PIX_IN_UPDATE",
"method": "PIX_IN",
"status": "PAYED",
"transactionId": "01961234-abcd-7000-8000-000000000001",
"idempotency": "pedido-12345",
"payer": {
"fullname": "João da Silva",
"document": "12345678900"
},
"pix": {
"endToEndId": "E12345678202301011200abcdefghijkl",
"txid": "txid-unico-gerado",
"value": "150.00",
"devolutions": []
}
}
{
"event": "PIX_IN_UPDATE",
"method": "PIX_IN",
"status": "REFUNDED",
"partial": false,
"transactionId": "01961234-abcd-7000-8000-000000000001",
"idempotency": "pedido-12345",
"payer": {
"fullname": "João da Silva",
"document": "12345678900"
},
"pix": {
"endToEndId": "E12345678202301011200abcdefghijkl",
"txid": "txid-unico-gerado",
"value": "150.00"
},
"refundedAmount": 150.00,
"devolutionSummary": {
"originalAmount": 150.00,
"refundedAmount": 150.00,
"pendingAmount": 0,
"remainingAmount": 0
},
"devolution": {
"id": "01961234-abcd-7000-8000-0000000000d2",
"endToEndId": "D12345678202501161000abcdefghijk",
"amount": 100.00,
"refundedAt": "2025-01-16T10:00:00.000Z",
"medRefund": false
},
"devolutions": [
{
"id": "01961234-abcd-7000-8000-0000000000d1",
"endToEndId": "D12345678202501151430abcdefghijk",
"amount": 50.00,
"refundedAt": "2025-01-15T14:30:00.000Z"
},
{
"id": "01961234-abcd-7000-8000-0000000000d2",
"endToEndId": "D12345678202501161000abcdefghijk",
"amount": 100.00,
"refundedAt": "2025-01-16T10:00:00.000Z"
}
]
}