---
title: "Webhook Resgate de Bônus"
method: POST
path: "/:webhook"
---

# Webhook Resgate de Bônus

`POST /:webhook`

Webhook disparado no momento que o cliente vai até a loja e utiliza o bônus

## Headers

- `Content-Type` string
- `Authorization` string

## Request body

- object
  - `bonus_id` integer — ID do Bônus
  - `user_id` integer — ID do cliente (consumidor final)
  - `user_phone` string — Número de telefone do cliente (consumidor) no formato +55 (DDD) 9XXXX-XXXX
  - `user_document_number` string — CPF do cliente (consumidor)
  - `user_name` string — Nome do cliente (consumidor)
  - `status` 'withdraw' | 'cancelled' | 'refunded' — Status do webhook. Cancelled = cancelado, refund = estorno, withdraw = resgate de bônus
  - `withdraw` object — Dados do resgate e utilização do bônus
    - `withdraw_date` string, date — Data do resgate do bônus
    - `order_total` number, float — Valor total da compra
    - `bonus_total` number, float — Valor total do bônus
    - `total_used_bonus` number, float — Valor total utilizado do bônus
    - `customer_id` integer — ID da loja resgate
    - `customer_cnpj` string — Caso a loja resgate seja a mesma loja que gerou o bônus, retorna CNPJ da loja resgate, senão, "Externo"
    - `customer_name` string — Caso a loja resgate seja a mesma loja que gerou o bônus, retorna o nome da loja resgate, senão, "Externo"
    - string
  - `cancelled` object — Dados do cancelamento do bônus
    - `cancelled_at` string, date — Data do cancelamento do bônus
    - `reason` string — Motivo do cancelamento do bônus
  - `refunded` object — Dados de estorno do bônus
    - `refunded_at` string, date — Data em que o bônus foi estornado

## Response `200`

200

- union
  - object
    - `bonus_id` integer
    - `user_id` integer
    - `user_phone` string
    - `user_document_number` string
    - `user_name` string
    - `status` string
    - `withdraw` object
      - `withdraw_date` string
      - `order_total` integer
      - `bonus_total` integer
      - `total_used_bonus` integer
      - `customer_id` integer
      - `customer_cnpj` string
      - `customer_name` string
  - object
    - `bonus_id` integer
    - `user_id` integer
    - `user_phone` string
    - `user_document_number` string
    - `user_name` string
    - `status` string
    - `cancelled` object
      - `cancelled_at` string
      - `reason` string
  - object
    - `bonus_id` integer
    - `user_id` integer
    - `user_phone` string
    - `user_document_number` string
    - `user_name` string
    - `status` string
    - `refunded` object
      - `refunded_at` string

---

[API](https://skmtc.net/crmbonus/apis/bi-crmb-nus.md) · [All operations](https://skmtc.net/crmbonus/apis/bi-crmb-nus/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crmbonus/bi-crmb-nus/versions/7f3ebb042f1a/schema)