WEBHOOK NOTIFICATIONS

Catálogo de Webhooks - iBaaS (Banking as a Service)

Este documento descreve cada um dos webhooks ativos em operação no ecossistema iBaaS. Os payloads são enviados para as URLs configuradas em /v1/baas/webhooks pelo parceiro para notificar em tempo real transações financeiras e eventos cadastrais de contas.

Categoria 1: Eventos de Conta

1. account_status_update

Este webhook é enviado quando ocorre uma atualização no status cadastral ou de aprovação de uma conta de cliente.

accountStatusEnum: "register", "validating", "validated", "processing", "awaiting_baas_creation", "rejected", "denied", "approved", "fail", "disabled", "blocked", "locked", "transactions_limit_update", "cancelled".

Exemplo de Payload:

{
    "webhook_type": "account_status_update",
    "account_uuid": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
    "account_status": "approved",
    "account_denied": false
}

Categoria 2: Transferências e Pagamentos Instantâneos (Pix)

2. WITHDRAW_INSTANT_PAYMENT

Este webhook é enviado quando uma transferência Pix (Cash-out) para outra instituição é solicitada e processada.

Exemplo de Payload:

{
    "transaction_id": "0547D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "1784",
    "callback_type": "WITHDRAW_INSTANT_PAYMENT",
    "status": "Approved",
    "original_amount": 10.00,
    "received_amount": 10.00,
    "recipient_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "mobile_phone_country": "BRA",
        "mobile_phone_number": "11933587601"
    },
    "financial_statement": {
        "status": "Approved"
    },
    "instant_payment": {
        "end_to_end_id": "E946428242023060915004bMcu01QJMl",
        "tx_id": "86696104000106",
        "sender": {
            "name": "João da Silva",
            "tax_id_number": "999999911111",
            "tax_id_country": "BRA",
            "ispb": {
                "id": "0001",
                "name": "Acme Bank"
            },
            "branch": "0001",
            "account": "123456",
            "account_type": "CC"
        },
        "recipient": {
            "name": "Maria da Silva",
            "tax_id_number": "999999922222",
            "tax_id_country": "BRA",
            "ispb": {
                "id": "0001",
                "name": "Acme Bank"
            },
            "branch": "0001",
            "account": "654321",
            "account_type": "CC"
        }
    }
}

3. PAYMENT_INSTANT_PAYMENT

Este webhook é enviado quando um pagamento via Pix (Cash-out), como leitura de QR Code ou Pix copia e cola, é efetuado com sucesso.

Exemplo de Payload:

{
    "transaction_id": "0547D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "1784",
    "callback_type": "PAYMENT_INSTANT_PAYMENT",
    "status": "Approved",
    "original_amount": 25.50,
    "received_amount": 25.50,
    "recipient_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "mobile_phone_country": "BRA",
        "mobile_phone_number": "11933587601"
    },
    "financial_statement": {
        "status": "Approved"
    },
    "instant_payment": {
        "end_to_end_id": "E946428242023060915004bMcu01QJMl",
        "tx_id": "86696104000106",
        "sender": {
            "name": "João da Silva",
            "tax_id_number": "999999911111",
            "tax_id_country": "BRA",
            "ispb": {
                "id": "0001",
                "name": "Acme Bank"
            },
            "branch": "0001",
            "account": "123456",
            "account_type": "CC"
        },
        "recipient": {
            "name": "Estabelecimento Exemplo LTDA",
            "tax_id_number": "11222333000199",
            "tax_id_country": "BRA",
            "ispb": {
                "id": "0002",
                "name": "Beta Bank"
            },
            "branch": "0001",
            "account": "987654",
            "account_type": "CC"
        }
    }
}

4. DEPOSIT_INSTANT_PAYMENT

Este webhook é enviado quando a conta do cliente recebe um Pix (Cash-in) enviado por qualquer instituição financeira.

Exemplo de Payload:

{
    "transaction_id": "3344D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "9827",
    "callback_type": "DEPOSIT_INSTANT_PAYMENT",
    "status": "Approved",
    "original_amount": 500.00,
    "received_amount": 500.00,
    "recipient_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "mobile_phone_country": "BRA",
        "mobile_phone_number": "11933587601"
    },
    "financial_statement": {
        "status": "Approved"
    },
    "instant_payment": {
        "end_to_end_id": "E000000002023060915004bMcu01QJMl",
        "tx_id": "86696104000106",
        "sender": {
            "name": "Pagador Externo Exemplo",
            "tax_id_number": "88888888811",
            "tax_id_country": "BRA",
            "ispb": {
                "id": "0088",
                "name": "Outro Banco"
            },
            "branch": "0001",
            "account": "888888",
            "account_type": "CC"
        },
        "recipient": {
            "name": "João da Silva",
            "tax_id_number": "999999911111",
            "tax_id_country": "BRA",
            "ispb": {
                "id": "0001",
                "name": "Acme Bank"
            },
            "branch": "0001",
            "account": "123456",
            "account_type": "CC"
        }
    }
}

Categoria 3: Boletos Bancários e Compensações

5. DEPOSIT_BOLETO

Este webhook é enviado quando ocorre o recebimento de valores na conta do cliente (Cash-in) através da compensação de um boleto de depósito emitido.

Exemplo de Payload:

{
    "transaction_id": "1122D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "BOL-9921",
    "callback_type": "DEPOSIT_BOLETO",
    "status": "Approved",
    "original_amount": 100.00,
    "received_amount": 100.00,
    "recipient_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "branch": "0001",
        "account": "12345-6",
        "holder_tax_id": "999999911111",
        "account_type": "CC",
        "mobile_phone_country": "BRA",
        "mobile_phone_number": "11933587601"
    },
    "financial_statement": {
        "status": "Approved"
    }
}

6. DEPOSIT_DIRECT_DEBIT

Este webhook é enviado quando ocorre a compensação e conciliação de um boleto de cobrança (fatura de lote) ou boleto de recarga de celular, creditando o saldo na conta recebedora do cliente.

Exemplo de Payload:

{
    "transaction_id": "0547D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "1784",
    "callback_type": "DEPOSIT_DIRECT_DEBIT",
    "status": "Approved",
    "original_amount": 150.00,
    "received_amount": 150.00,
    "recipient_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "branch": "0001",
        "account": "12345-6",
        "holder_tax_id": "999999922222",
        "account_type": "CC",
        "account_holder_id": "HOLDER-UUID-1234",
        "mobile_phone_country": "BRA",
        "mobile_phone_number": "11933587601"
    },
    "financial_statement": {
        "status": "Approved",
        "authorization_details": {
            "number": "875643"
        }
    }
}

7. WITHDRAW_BOLETO

Este webhook é enviado quando o cliente realiza um pagamento de boleto bancário de terceiros (Cash-out) debitando o saldo da sua conta.

Exemplo de Payload:

{
    "transaction_id": "5566D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "PGTO-BOL-882",
    "callback_type": "WITHDRAW_BOLETO",
    "status": "Approved",
    "original_amount": 89.90,
    "received_amount": 89.90,
    "sender_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "branch": "0001",
        "account": "12345-6",
        "holder_tax_id": "999999911111",
        "account_type": "CC"
    },
    "financial_statement": {
        "status": "Approved"
    }
}

8. PAYMENT_BOLETO

Este webhook é enviado quando um pagamento de boleto (Cash-out) é processado no sistema.

Exemplo de Payload:

{
    "transaction_id": "5566D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "PGTO-BOL-882",
    "callback_type": "PAYMENT_BOLETO",
    "status": "Approved",
    "original_amount": 250.00,
    "received_amount": 250.00,
    "sender_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "branch": "0001",
        "account": "12345-6",
        "holder_tax_id": "999999911111",
        "account_type": "CC"
    },
    "financial_statement": {
        "status": "Approved"
    }
}

Categoria 4: Transferências Bancárias (TED)

Em desenvolvimento.

Categoria 5: Outros Pagamentos e Transferências

10. WITHDRAW_UTILITIES

Este webhook é enviado quando um pagamento de concessionária/convênio (água, luz, telefone, tributos, etc.) é debitado e pago na conta do cliente.

Exemplo de Payload:

{
    "transaction_id": "1199D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "CONV-0012",
    "callback_type": "WITHDRAW_UTILITIES",
    "status": "Approved",
    "original_amount": 115.40,
    "received_amount": 115.40,
    "sender_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "branch": "0001",
        "account": "12345-6",
        "holder_tax_id": "999999911111",
        "account_type": "CC"
    },
    "financial_statement": {
        "status": "Approved"
    }
}

11. INTERNAL_PAYMENT

Este webhook é enviado quando ocorre uma transferência interna (P2P) entre duas contas dentro do próprio gateway.

Exemplo de Payload:

{
    "transaction_id": "3322D708-6044-DA40-54F8-535BFDF7BD1D",
    "external_identifier": "P2P-876",
    "callback_type": "INTERNAL_PAYMENT",
    "status": "Approved",
    "original_amount": 50.00,
    "received_amount": 50.00,
    "sender_account": {
        "account_id": "B2396FA4-37C1-0BEE-A35A-3B561BE0893A",
        "branch": "0001",
        "account": "12345-6",
        "holder_tax_id": "999999911111",
        "account_type": "CC"
    },
    "recipient_account": {
        "account_id": "A4423FA4-37C1-0BEE-A35A-3B561BE0893F",
        "branch": "0001",
        "account": "65432-1",
        "holder_tax_id": "88888888899",
        "account_type": "CC"
    },
    "financial_statement": {
        "status": "Approved"
    }
}

Catálogo de Webhooks - iBaaS (Banking as a Service)#

Categoria 1: Eventos de Conta#

1. account_status_update#

Categoria 2: Transferências e Pagamentos Instantâneos (Pix)#

2. WITHDRAW_INSTANT_PAYMENT#

3. PAYMENT_INSTANT_PAYMENT#

4. DEPOSIT_INSTANT_PAYMENT#

Categoria 3: Boletos Bancários e Compensações#

5. DEPOSIT_BOLETO#

6. DEPOSIT_DIRECT_DEBIT#

7. WITHDRAW_BOLETO#

8. PAYMENT_BOLETO#

Categoria 4: Transferências Bancárias (TED)#

Categoria 5: Outros Pagamentos e Transferências#

10. WITHDRAW_UTILITIES#

11. INTERNAL_PAYMENT#

Catálogo de Webhooks - iBaaS (Banking as a Service)

Categoria 1: Eventos de Conta

1. account_status_update

Categoria 2: Transferências e Pagamentos Instantâneos (Pix)

2. WITHDRAW_INSTANT_PAYMENT

3. PAYMENT_INSTANT_PAYMENT

4. DEPOSIT_INSTANT_PAYMENT

Categoria 3: Boletos Bancários e Compensações

5. DEPOSIT_BOLETO

6. DEPOSIT_DIRECT_DEBIT

7. WITHDRAW_BOLETO

8. PAYMENT_BOLETO

Categoria 4: Transferências Bancárias (TED)

Categoria 5: Outros Pagamentos e Transferências

10. WITHDRAW_UTILITIES

11. INTERNAL_PAYMENT