PARTIALLY_REFUNDED enquanto a soma das devoluções não chega ao valor do saque e REFUNDED na devolução que completa (veja Devoluções no webhook).
| Campo | Tipo | Descrição |
|---|---|---|
event | string | Sempre PIX_OUT_UPDATE |
method | string | Sempre PIX_OUT |
status | string | PAID, REJECTED, ERROR, PARTIALLY_REFUNDED ou REFUNDED |
transactionId | string | ID da transação no Alpha Gateway |
idempotency | string | Chave de idempotência enviada na criação |
value | number | Valor solicitado |
valueFee | number | Taxa cobrada |
valueLiquid | number | Total debitado do seu saldo (valor + taxa); o destinatário recebe value |
destination.pixKey | string | Chave PIX de destino |
destination.pixType | string | Tipo da chave: DOCUMENT, EMAIL, PHONE ou RANDOM |
customer.fullName | string | Nome do beneficiário |
customer.document | string | CPF ou CNPJ do beneficiário |
endToEndId | string | Identificador end-to-end (quando disponível) |
messageError | string | Mensagem de erro (apenas para REJECTED e ERROR) |
refundedAmount | number | Total devolvido pelo recebedor até esta devolução e creditado no saldo (apenas nas devoluções; a taxa não é devolvida) |
devolutionSummary | object | Resumo: originalAmount (valor do saque), refundedAmount (devolvido), pendingAmount (devolvido antes da confirmação e ainda não creditado) e remainingAmount (apenas nas devoluções) |
devolutions | array | Todas as devoluções do saque até esta, em ordem, com id, endToEndId, amount e refundedAt (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 e refundedAt (apenas nas devoluções) |
{
"event": "PIX_OUT_UPDATE",
"method": "PIX_OUT",
"status": "PAID",
"transactionId": "01961234-abcd-7000-8000-000000000002",
"idempotency": "saque-67890",
"value": 100.00,
"valueFee": 2.50,
"valueLiquid": 102.50,
"destination": {
"pixKey": "12345678900",
"pixType": "DOCUMENT"
},
"customer": {
"fullName": "Maria Oliveira",
"document": "12345678900"
},
"endToEndId": "E12345678202301011200abcdefghijkl"
}
{
"event": "PIX_OUT_UPDATE",
"method": "PIX_OUT",
"status": "REJECTED",
"transactionId": "01961234-abcd-7000-8000-000000000002",
"idempotency": "saque-67890",
"value": 100.00,
"valueFee": 2.50,
"valueLiquid": 102.50,
"destination": {
"pixKey": "12345678900",
"pixType": "DOCUMENT"
},
"customer": {
"fullName": "Maria Oliveira",
"document": "12345678900"
},
"messageError": "Chave PIX de destino inválida"
}
{
"event": "PIX_OUT_UPDATE",
"method": "PIX_OUT",
"status": "REFUNDED",
"partial": false,
"transactionId": "01961234-abcd-7000-8000-000000000002",
"idempotency": "saque-67890",
"value": 100.00,
"valueFee": 2.50,
"valueLiquid": 102.50,
"destination": {
"pixKey": "12345678900",
"pixType": "DOCUMENT"
},
"customer": {
"fullName": "Maria Oliveira",
"document": "12345678900"
},
"endToEndId": "E12345678202301011200abcdefghijkl",
"refundedAmount": 100.00,
"devolutionSummary": {
"originalAmount": 100.00,
"refundedAmount": 100.00,
"pendingAmount": 0,
"remainingAmount": 0
},
"devolution": {
"id": "01961234-abcd-7000-8000-0000000000d3",
"endToEndId": "D98765432202501171200abcdefghijk",
"amount": 100.00,
"refundedAt": "2025-01-17T12:00:00.000Z"
},
"devolutions": [
{
"id": "01961234-abcd-7000-8000-0000000000d3",
"endToEndId": "D98765432202501171200abcdefghijk",
"amount": 100.00,
"refundedAt": "2025-01-17T12:00:00.000Z"
}
]
}