Pagamento Único

Webhook disparado quando uma venda de pagamento único é aprovada.

Evento

event · string

purchase_approved

Exemplo de payload

{
  "secret": "123",
  "event": "purchase_approved",
  "data": {
    "id": "81b408ee-2a91-427d-80bd-226cbeae1fa0",
    "refId": "AUAe5xK",
    "customer": {
      "name": "Example",
      "birthDate": "2000-04-09",
      "email": "[e-mail]",
      "phone": "34999999999"
    },
    "affiliate": "[e-mail]",
    "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": "[e-mail]",
      "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": "[e-mail]",
        "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.PIX...",
      "expirationDate": "2024-08-22 17:25:14.804059+00:00"
    }
  }
}

Campos do payload

id · string

Identificador único do pedido (UUID).

refId · string

Identificador curto de referência do pedido.

customer · object

Dados do cliente que realizou a compra.

Show Propriedades

name · string

Nome completo do cliente.

birthDate · string

Data de nascimento no formato YYYY-MM-DD.

email · string

E-mail do cliente.

phone · string

Telefone do cliente.

affiliate · string

E-mail do afiliado responsável pela venda. Vazio se não houver afiliado.

offer · object

Dados da oferta adquirida.

Show Propriedades

id · string

ID da oferta.

name · string

Nome da oferta.

price · number

Preço da oferta.

product · object

Dados do produto.

Show Propriedades

name · string

Nome do produto.

id · string

ID do produto (UUID).

short_id · string

ID curto do produto.

type · string

Tipo do produto. unique para pagamento único.

status · string

Status do pagamento. Veja a referência de status.

amount · number

Valor final cobrado.

fees · number

Taxas da plataforma descontadas.

paymentMethod · string

Método de pagamento utilizado. Veja métodos de pagamento.

paidAt · string

Data e hora do pagamento em formato ISO 8601.