Modelo Webhook
Webhook de pix cash out (CONFIRMED) Entity: pix-payment-out
{
"entity": "pix-payment-out",
"createTimestamp": "2023-07-27T10:03:31.2333952",
"status": "CONFIRMED",
"body": {
"amount": 392,
"oldBalance": 50,
"currentBalance": 6.52,
"clientCode": 5411124227,
"debitParty": {
"taxId": 46463721000,
"name": "TESTE",
"branch": 1,
"account": 300123,
"accountType": "TRAN"
},
"id": "7d89772a-6fbe-4cbf-a3c3-fc7f31aa63c9",
"endToEndId": "E1393589320230727130301498341234",
"creditParty": {
"bank": 18236120,
"taxId": 46463721000,
"name": "TESTE",
"branch": 1,
"account": 300123,
"accountType": "TRAN"
},
"initiationType": "MANUAL",
"transactionType": "TRANSFER",
"urgency": "HIGH",
"paymentType": "IMMEDIATE",
"dataInsercao": "2025-06-18T11:24:37.609+00:00"
}
}Webhook de pix cash out (PENDING, bloqueio cautelar/limite máximo diferenciado) Entity: pix-payment-out
{
"webhookId": "a76919e6-9c8e-465c-ac78-141727393757-pending",
"createTimeStamp": "2026-02-05T11:51:24.957536",
"body": {
"reason": "Sua transação está em análise",
"amount": 0.01,
"debitParty": {
"taxId": "12345678911",
"accountType": "TRAN",
"name": "teste pix",
"branch": "0001",
"account": "123456"
},
"dataInsercao": "2026-02-05T11:51:21.098+00:00",
"endToEndId": "E1393589320230727130301498341234",
"paymentType": "IMMEDIATE",
"initiationType": "DICT",
"transactionType": "TRANSFER",
"urgency": "HIGH",
"remittanceInformation": "Texto de mensagem",
"clientCode": "14450e60-b740-4665-9108-bab848ateste",
"id": "a76919e6-9c8e-465c-ac78-1417273teste",
"creditParty": {
"bank": "13935893",
"taxId": "12345678911",
"accountType": "TRAN",
"name": "teste pix",
"branch": "1",
"account": "123456789",
"key": "[email protected]"
}
},
"entity": "pix-payment-out",
"status": "PENDING"
}Webhook de pix cash out (ERROR) Entity: pix-payment-out
{
"webhookId": "a76919e6-9c8e-465c-ac78-141727393757-pending",
"createTimeStamp": "2026-02-05T11:51:24.957536",
"body": {
"amount": 0.01,
"debitParty": {
"taxId": "12345678911",
"accountType": "TRAN",
"name": "teste pix",
"branch": "0001",
"account": "30023646051234"
},
"dataInsercao": "2026-02-05T11:51:21.098+00:00",
"endToEndId": "E13935893202602051451cIJnZ052026",
"paymentType": "IMMEDIATE",
"initiationType": "DICT",
"transactionType": "TRANSFER",
"urgency": "HIGH",
"remittanceInformation": "Texto de mensagem",
"clientCode": "14450e60-b740-4665-9108-bab848ateste",
"id": "a76919e6-9c8e-465c-ac78-1417273teste",
"creditParty": {
"bank": "13935893",
"taxId": "12345678911",
"accountType": "TRAN",
"name": "teste pix",
"branch": "1",
"account": "123456789",
"key": "[email protected]"
}
},
"error": {
"errorCode": "PBE343",
"message": "Settlement of the transaction has failed"
},
"entity": "pix-payment-out",
"status": "ERROR"
}Tabela de apoio
| Campo | Descrição |
|---|---|
| amount | Valor do recebimento |
| oldBalance | Saldo anterior |
| currentBalance | Saldo atual |
| debitParty | Dados do pagador |
| bank | ISPB do banco do pagador |
| taxId | CPF/CNPJ do pagador |
| name | Nome do pagador |
| branch | Agência do banco do pagador |
| account | Número da conta do pagador |
| accountType | Tipo de conta |
| id | identificador do recebimento |
| endToEndId | Identificador ponta-a-ponta associado ao pagamento. |
| creditParty | Dados do creditado |
| bank | ISPB do banco creditado |
| taxId | CPF/CNPJ do creditado |
| name | Nome de quem será creditado |
| branch | Agência do creditado |
| account | Número da conta do creditado |
| accountType | Tipo da conta |
| initiationType | Tipo de iniciação do pagamento (MANUAL, DICT, STATIC_QRCODE, DYMANIC_QRCODE) |
| transactionType | Tipo da transação Pix |
| urgency | Determina a urgência do pagamento |
| paymentType | Tipo de pagamento (IMMEDIATE, FRAUD, SCHEDULED) |
Webhook de recebimento de devolução pix
Entity: pix-reversal-in
{
"entity": "pix-reversal-in",
"createTimestamp": "2023-07-27T11:17:57.783+00:00",
"status": "CONFIRMED",
"body": {
"amount": 40.97,
"oldBalance": 10,
"id": "8a18df09-5155-4397-acc1-3dc61df1d151",
"reason": "MD06",
"originalClientCode": "76d1d810-6ecd-41b4-9724-e3daca0e722f",
"returnIdentification": "D10573521202307271417gUTeaw9DZC4",
"originalId": "092294bc-7cc1-4575-811a-1191e7e315f0",
"originalEndToEndId ": "E1393589320230727130301498341234",
"debitParty": {
"taxId": "46463721000",
"accountType": "TRAN",
"name": "TESTE",
"bank": "10573521",
"branch": "0001",
"account": "300123"
},
"creditParty": {
"bank": "60701190",
"taxId": "46463721000",
"accountType": "CACC",
"name": "TESTE",
"branch": "360",
"account": "300123"
}
}| amount | Valor |
| oldBalance | Saldo anterior |
| id | Identificador único da transação de devolução |
| reason | Razão da devolução |
| originalClientCode | ClientCode original da transação de cashout |
| returnIdentification | EndToEnd da transação de devolução |
| originalId | Id original da transação de cashout |
| originalEntoEndId | E2EId original da transação de cashout, identificador de ponta a ponta |
| debitParty | Dados bancários da conta do pagador na Celcoin |
| creditParty | Dados bancários da conta do recebedor. |
| bank | ISPB do banco |
| taxId | CPF/CNPJ |
| accountType | Tipo da conta |
| name | Nome do titular da conta |
| branch | Agência da conta |
| account | Número da conta |
Updated 8 days ago