API V1Voltar ao Wpix

Wpix Developers / API v1

Referência

Resumo dos endpoints v1. A fonte canônica de contrato é o OpenAPI YAML.

Wpix developer console

Veja o fluxo em ação

Simulado

Escolha uma etapa, troque a linguagem e leve o código para o seu backend. Nenhuma chamada é feita daqui.

Somente RECEIVED por padrão. Requer escopo donations:read. Paginação via next_cursor → before.

GET/api/v1/donations?limit=20donations:read

Request

$ curl -sS "https://SEU_DOMINIO/api/v1/donations?limit=20" \
  -H "Authorization: Bearer $WPIX_API_KEY"

Exemplo de resposta

{
  "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"
}

Use WPIX_API_KEY apenas no servidor. Para ver todo o contrato, consulte a especificação OpenAPI.

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

Objeto Donation#

Campos expostos:

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

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.

Developers

API V1Voltar ao Wpix

Wpix Developers / API v1

Referência

Resumo dos endpoints v1. A fonte canônica de contrato é o OpenAPI YAML.

Wpix developer console

Veja o fluxo em ação

Simulado

Escolha uma etapa, troque a linguagem e leve o código para o seu backend. Nenhuma chamada é feita daqui.

Somente RECEIVED por padrão. Requer escopo donations:read. Paginação via next_cursor → before.

GET/api/v1/donations?limit=20donations:read

Request

$ curl -sS "https://SEU_DOMINIO/api/v1/donations?limit=20" \
  -H "Authorization: Bearer $WPIX_API_KEY"

Exemplo de resposta

{
  "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"
}

Use WPIX_API_KEY apenas no servidor. Para ver todo o contrato, consulte a especificação OpenAPI.

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

Objeto Donation#

Campos expostos:

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

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.

Referência de endpoints · Wpix Developers