Pular para o conteúdo principal

Webhooks

Events are sent via an HTTP request, using the method previously registered for your endpoint URL, and can include a header for validation. The structure of the event sent follows the model shown below, with the content varying according to the subscription type. To configure your webhook, access your dashboard then go to Settings => Webhooks.

CashIn examples​

Generate Payment QrCode​

{
    "transactionId": 1000,
    "object": "cashin",
    "status": "created",
    "method": "pix",
    "value": 500, // in cents
    "processedAt": "2025-04-02T13:26:52.0365664Z",
    "orderId": "test-123",
    "observation": null
}

Confirm Payment QrCode Event​

{
    "transactionId": 1000,
    "object": "cashin",
    "status": "paid",
    "method": "pix",
    "value": 500, // in cents
    "endToEndId":"E18236120202509231211s04b597fb3c",
    "processedAt": "2025-04-02T13:26:52.0365664Z",
    "payer":{
        "transactionId":1000,
        "name":"Fulano de Tal da Silva",
        "documentId":"80683806556",
        "bankName":null,
        "bankCode":null,
        "bankIspb":"18236120"
    },
    "orderId": "test-123",
    "observation": null
}

CashOut examples​

Create payout​

{
    "transactionId": 2000,
    "object": "transfer",
    "status": "created",
    "method": "pix",
    "value": 500, // in cents
    "processedAt": "2025-04-02T14:26:52.0365664Z",
    "destinationBank": null,
    "orderId": "test-123",
    "observation": null
}

Confirm payout​

{
    "transactionId": 2000,
    "object": "transfer",
    "status": "paid",
    "method": "pix",
    "value": 500, // in cents
    "endToEndId": "E3571349120350923320635128eb360b",
    "processedAt": "2025-04-02T14:26:52.0365664Z",
    "destinationBank": {
        "name":"Fulano de Tal da Silva",
        "cpfCnpj":"80683806556",
        "email":null,
        "pixKey":"80683806556",
        "pixKeyType":"",
        "bank": null,
        "bankId":null,
        "ispb":null
    },
    "orderId": "test-123",
    "observation": null
}

Others​

Transaction refund​

{
    "transactionId": 1000,
    "object": "cashin",
    "status": "refund",
    "method": "pix",
    "value": 500, // in cents
    "processedAt": "2025-04-02T13:26:52.0365664Z",
    "destinationBank": {
        "name":"Fulano de Tal da Silva",
        "cpfCnpj":"80683806556",
        "email":null,
        "pixKey":"80683806556",
        "pixKeyType":"",
        "bank": null,
        "bankId":null,
        "ispb":null
    },
    "orderId": "test-123",
    "observation": "Reason for infraction"
}

Transaction infraction​

{
    "transactionId": 1000,
    "object": "cashin",
    "status": "infraction",
    "method": "pix",
    "value": 500, // in cents
    "processedAt": "2025-06-02T13:26:52.0365664Z",
    "orderId": "test-123",
    "observation": "Reason for infraction"
}

Payout refund​

{
    "transactionId": 1000,
    "object": "transfer",
    "status": "refund",
    "method": "pix",
    "value": 500, // in cents
    "processedAt": "2025-06-02T13:26:52.0365664Z",
    "orderId": "test-123",
    "observation": "Reason for refund"
}