Skip to main content
WEBHOOK
/
webhooks
/
checkout
{
  "id": "evt_4a8b3c1d5e6f2a9b0c1d2e3f",
  "type": "checkout.paid",
  "createdAt": "2026-04-25T14:02:10.000Z",
  "livemode": false,
  "data": {
    "checkout": {
      "id": "chk_4a8b3c1d5e6f2a9b0c1d",
      "livemode": false,
      "status": "PAID",
      "amount": 12990,
      "currency": "BRL",
      "description": "Plano Pro",
      "externalId": "order_1001",
      "checkoutUrl": "https://pay.troqpay.com/pay/chk_4a8b3c1d5e6f2a9b0c1d",
      "createdAt": "2026-04-25T14:00:00.000Z",
      "expiresAt": "2026-04-25T14:30:00.000Z",
      "paidAt": "2026-04-25T14:02:10.000Z",
      "customer": {
        "name": "Maria Silva",
        "email": "maria@example.com",
        "document": null
      },
      "pix": {
        "copyPaste": "00020101021226840014br.gov.bcb.pix...",
        "qrCodeUrl": "https://api.troqpay.com/qrcode/chk_4a8b3c1d5e6f2a9b0c1d.png"
      },
      "settlement": {
        "currency": "BRL",
        "status": "AVAILABLE",
        "amount": "129.90"
      },
      "metadata": {
        "plan": "pro"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.troqpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-troqpay-signature
string
required

HMAC_SHA256(rawBody, signingSecret).hex(). O segredo é único por endpoint cadastrado no app. Compare a assinatura calculada do seu lado com o valor recebido antes de processar o evento.

Example:

"2d4d947f80b9b84efc3a3ec9a13d2f3d7e824bf3ce1e1b7d1a3267570d51d4a2"

Body

application/json

Envelope de evento de webhook. data.checkout é o checkout completo — a mesma forma retornada por GET /v1/checkouts/{checkoutId}.

​
id
string
required

Identificador único do evento. Formato evt_ + 24 caracteres hex.

Example:

"evt_4a8b3c1d5e6f2a9b0c1d2e3f"

​
type
enum<string>
required

Tipo do evento.

Available options:
checkout.created,
checkout.paid,
checkout.expired
​
createdAt
string<date-time>
required

Quando o evento foi criado.

​
livemode
boolean
required

true para checkouts em produção, false para teste.

Example:

false

​
data
object
required

Objeto de dados entregue no webhook.

Response

200

Retorne qualquer status 2xx dentro de 5 segundos para confirmar o recebimento. A troqpay tenta entregar até 5 vezes com backoff 60s → 5m → 15m → 60m. O entregador não segue redirects: qualquer 3xx no seu endpoint vira falha.