Referência de endpoints · Wpix Developers

{ "donations": [ { "id": "00000000-0000-4000-8000-0000000000aa", "donor_name": "Fulano", "message": "Boa live!", "amount_cents": 1000, "status": "RECEIVED", "paid_at": "2026-07-07T21:00:00.000Z", "created_at": "2026-07-07T21:00:00.000Z" } ], "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNy0wN1QyMTowMDowMC4wMDBaIiwiaWQiOiIwMDAwMDAwMC0wMDAwLTQwMDAtODAwMC0wMDAwMDAwMDAwYWEifQ" }

O API Playground gera requests de exemplo alinhados a esta referência e ao OpenAPI.

Endpoints#

GET/api/v1/me

Confirma a API key e retorna o streamer dono dela

Respostas

GET/api/v1/donationsdonations:read

Lista doações RECEIVED do streamer dono da API key

Query

limit (integer) — 1–100, padrão 20
before (string) — Cursor opaco (next_cursor da página anterior)
since (string) — ISO 8601 — doações a partir desta data
status (string) — Nesta versão apenas RECEIVED

Respostas

GET/api/v1/donations/{id}donations:read

Detalhe de uma doação específica

Path

id (uuid) — ID da doação

Respostas

POST/api/v1/chargescharges:write

Cria cobrança Pix de integração ou devolve a mesma reference (200)

Respostas

GET/api/v1/charges/{id}charges:write

Consulta cobrança Pix criada via integração (com reference)

Path

id (uuid) — ID da cobrança/doação

Respostas

Objeto Donation#

Campos expostos:

id, donor_name, message, amount_cents, status, paid_at, created_at, reference

Nunca expostos:

donor_email
provider_charge_id
provider_order_id
qr_payload
dados de pagamento internos

OpenAPI#

Download: /openapi/v1.yaml. Arquivo no repo: docs/specs/openapi-v1.yaml.