Seja bem-vindo(a) à documentação de Webhooks da Cakto! Essas informações te ajudarão a integrar e automatizar seus processos de forma simples e eficiente.

<aside> 💡

Os webhooks enviam uma requisição POST com informações sobre cada pedido. A Cakto interpreta qualquer resposta do seu sistema como entregue.

</aside>

<aside> 💡

Há um limite de tempo de 10 segundos em que é aguardado a confirmação do recebimento da requisição por parte do seu sistema, caso não haja nenhum tipo de resposta é feito 4 tentativas adicionais.

</aside>


Exemplo de webhook em vendas de pagamento único.

{
    "secret": "123",
    "event": "purchase_approved",
    "data": {
        "id": "81b408ee-2a91-427d-80bd-226cbeae1fa0",
        "refId": "AUAe5xK",
        "customer": {
            "name": "Example",
            "birthDate": "2000-04-09",
            "email": "[email protected]",
            "phone": "34999999999"
        },
        "affiliate": "[email protected]",
        "offer": {
            "id": "B8BcHrY",
            "name": "Offer Example",
            "price": 5.55
        },
        "offer_type": "main",
        "product": {
            "name": "Webhook Example",
            "id": "cd287b31-d4b7-4e94-858a-96e05ce2f4a2",
            "short_id": "49bruPi",
            "supportEmail": "[email protected]",
            "type": "unique",
            "invoiceDescription": "213"
        },
        "parent_order": "",
        "checkoutUrl": "<https://pay.cakto.com.br/B8BcHrY>",
        "status": "paid",
        "baseAmount": 5.55,
        "discount": "0.00",
        "amount": 5.55,
        "commissions": [
            {
                "user": "[email protected]",
                "totalAmount": 3.06,
                "percentage": 100.0,
                "type": "producer"
            }
        ],
        "fees": 2.49,
        "couponCode": null,
        "reason": null,
        "refund_reason": null,
        "paymentMethod": "pix",
        "installments": 1,
        "paidAt": "2024-08-22T11:39:57.113068-03:00",
        "createdAt": "2024-08-22T11:38:32.945877-03:00",
        "pix": {
            "qrCode": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/b8e8a562-77b9-4d0f-9f48-7d99303bf5f25204000053039865802BR5909CAKTO PAY6009SAO PAULO62070503***630476FD",
            "expirationDate": "2024-08-22 17:25:14.804059+00:00"
        }
    }
}

Exemplo de webhook em vendas de pagamento recorrente.

{
  "secret": "8402b43f-c839-4090-bbd1-186725d185c7",
  "event": "purchase_approved",
  "data": {
    "id": "1f1c81d2-088a-412d-8bb7-3d5269d64f58",
    "refId": "6HngVo6",
    "customer": {
      "name": "Tulio sabino",
      "birthDate": null,
      "email": "[email protected]",
      "phone": "5534991462388",
      "docNumber": "59089477098"
    },
    "affiliate": "",
    "offer": {
      "id": "jbwjmis",
      "name": "Subscription [Stg]",
      "price": 5
    },
    "offer_type": "main",
    "product": {
      "name": "Subscription [Stg]",
      "id": "f947c21c-d8f0-41a1-a0a6-fede9f27b3b7",
      "short_id": "6dRMZ6z",
      "supportEmail": "[email protected]",
      "type": "subscription",
      "invoiceDescription": ""
    },
    "parent_order": "PEtfqq3",
    "subscription": {
      "id": "d464132a-fcfa-4693-a6aa-a99483f06740",
      "status": "active",
      "current_period": 8,
      "recurrence_period": 2,
      "quantity_recurrences": -1,
      "trial_days": 0,
      "max_retries": 2,
      "amount": "5.00",
      "retry_interval": 2,
      "paid_payments_quantity": 8,
      "parent_order": "6a7377f9-da5d-47a8-ba43-dd6c80e46059",
      "paymentMethod": "credit_card",
      "customer": {
        "name": "Tulio sabino",
        "email": "[email protected]",
        "phone": "5534991462388",
        "birthDate": null,
        "docNumber": "59089477098",
        "docType": "cpf"
      },
      "product": "f947c21c-d8f0-41a1-a0a6-fede9f27b3b7",
      "offer": "jbwjmis",
      "orders": [
        "76c21519-3df3-400d-9c53-3be638a33998",
        "70b81b3f-536c-4ac7-a37a-309602bf2f85",
        "b7d16391-703d-4ebb-9ea8-79171ace8275",
        "196565bf-cebd-483e-816a-ef6c70fd091a",
        "1e8a2c5e-bd90-43fe-a6a8-2297ca413803",
        "2d732302-985a-426f-b4f7-8a0798123530",
        "1f1c81d2-088a-412d-8bb7-3d5269d64f58",
        "5b0d0c6d-b31e-43c5-9d4b-471c8cfb608c",
        "6a7377f9-da5d-47a8-ba43-dd6c80e46059"
      ],
      "next_payment_date": "2025-04-08T14:43:39.724743-03:00",
      "createdAt": "2025-04-08T14:41:42.247628-03:00",
      "updatedAt": "2025-04-08T14:41:42.247138-03:00",
      "canceledAt": null
    },
    "subscription_period": 2,
    "checkoutUrl": null,
    "status": "paid",
    "baseAmount": 5,
    "discount": null,
    "amount": 5,
    "commissions": [
      {
        "user": "[email protected]",
        "totalAmount": 2.36,
        "percentage": 100,
        "type": "producer"
      }
    ],
    "fees": 2.64,
    "couponCode": null,
    "reason": null,
    "refund_reason": null,
    "paymentMethod": "credit_card",
    "paymentMethodName": "Cartão de Crédito",
    "installments": 1,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_term": null,
    "utm_content": null,
    "sck": null,
    "fbc": null,
    "fbp": null,
    "paidAt": "2025-04-08T14:43:43.575271-03:00",
    "createdAt": "2025-04-08T14:43:43.022292-03:00",
    "refundedAt": null,
    "chargedbackAt": null,
    "card": {
      "holderName": "Tulio sabino",
      "lastDigits": "4242",
      "brand": null
    }
  }
}

Status de pagamento


Método de pagamento

O método de pagamento vai influenciar no modelo do webhook enviado, por isso, é importante entender que alguns campos só estarão disponíveis em alguns casos.

O Pix vai ter uma duração de 45 dias a partir da hora que ele foi criado.

Campos por método de pagamento: