Ambiente de simulação — nenhuma cobrança real. Os pagamentos, Pix e cartões deste sandbox são sintéticos.
W Wolf Sandbox Docs Criar conta
Navegação

Referência da API

API Keys

API keys do seller (só por sessão humana do app do seller).

get/v1/api-keys

Listar API keys (listApiKeys)

Chave vencida aparece com status: "expired".

rate limit: api_authenticated
  • Autenticação: sessão do app do seller
  • Escopos: api-keys:write
  • URL: https://api.v2.wolfpayteste.online/v1/api-keys

Parâmetros

NomeOndeTipoDetalhes
wolf-organization-id cabeçalho string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

API keys (sem segredo).

Resposta 200 de listApiKeys
Campo Tipo Detalhes
data obrigatório ApiCredential[]
Exemplo de resposta 200 json
{
  "data": [
    {
      "id": "key_0a1b2c3d4e5f60718293a4b5c6d7e8f9",
      "name": "Integração da loja",
      "key_prefix": "sk_test_a1B2c3D4e5F6",
      "scopes": [
        "payments:read",
        "payments:write",
        "refunds:write"
      ],
      "status": "active",
      "expires_at": "2027-11-06T00:00:00.000Z",
      "last_used_at": null,
      "created_at": "2026-11-06T12:00:00.000Z",
      "revoked_at": null
    }
  ]
}

Erros

post/v1/api-keys

Criar API key (createApiKey)

Nesta edição só emite sk_test_. expires_at é opcional (instante ISO-8601 com offset, no futuro e em até 365 dias). O secret é exibido uma única vez. Repetir a requisição com a mesma Idempotency-Key e o mesmo corpo devolve a mesma resposta com idempotent-replayed: true; corpo diferente → 409 IDEMPOTENCY_CONFLICT.

Idempotency-Key obrigatória rate limit: api_authenticated
  • Autenticação: sessão do app do seller
  • Escopos: api-keys:write
  • URL: https://api.v2.wolfpayteste.online/v1/api-keys

Parâmetros

NomeOndeTipoDetalhes
Idempotency-Keyobrigatório cabeçalho string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id cabeçalho string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto CreateApiCredentialRequest

Corpo de createApiKey
Campo Tipo Detalhes
name obrigatório string

2 a 80 caracteres

scopes obrigatório string[]

Valores: payments:read, payments:write, refunds:write, products:read, products:write, offers:read, offers:write, orders:read, orders:write, reports:read, finance:read, webhooks:write, api-keys:write, checkout.exports:create, checkout.exports:read

1 a n itens

expires_at string (data-hora ISO-8601) | null
Exemplo de corpo json
{
  "name": "Integração da loja",
  "scopes": [
    "payments:read",
    "payments:write",
    "refunds:write"
  ],
  "expires_at": "2027-11-06T00:00:00Z"
}

Resposta 201

API key criada (ou replay sem o segredo).

Um destes formatos:

Exemplo de resposta 201 json
{
  "credential": {
    "id": "key_0a1b2c3d4e5f60718293a4b5c6d7e8f9",
    "name": "Integração da loja",
    "key_prefix": "sk_test_a1B2c3D4e5F6",
    "scopes": [
      "payments:read",
      "payments:write",
      "refunds:write"
    ],
    "status": "active",
    "expires_at": "2027-11-06T00:00:00.000Z",
    "last_used_at": null,
    "created_at": "2026-11-06T12:00:00.000Z",
    "revoked_at": null
  },
  "secret": "sk_test_EXEMPLO_segredo_exibido_uma_unica_vez"
}

Erros

post/v1/api-keys/{id}/revoke

Revogar API key (revokeApiKey)

rate limit: api_authenticated
  • Autenticação: sessão do app do seller
  • Escopos: api-keys:write
  • URL: https://api.v2.wolfpayteste.online/v1/api-keys/{id}/revoke

Parâmetros

NomeOndeTipoDetalhes
idobrigatório caminho string

Id da API key (key_...).

mínimo 1 caractere(s)

wolf-organization-id cabeçalho string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

API key revogada.

Objeto ApiCredential

Resposta 200 de revokeApiKey
Campo Tipo Detalhes
id obrigatório string

Começa com key_

name obrigatório string
key_prefix obrigatório string
scopes obrigatório string[]

Valores: payments:read, payments:write, refunds:write, products:read, products:write, offers:read, offers:write, orders:read, orders:write, reports:read, finance:read, webhooks:write, api-keys:write, checkout.exports:create, checkout.exports:read

status obrigatório string

Valores: active, revoked, expired

expires_at obrigatório string | null
last_used_at obrigatório string | null
created_at obrigatório string
revoked_at obrigatório string | null
Exemplo de resposta 200 json
{
  "id": "key_0a1b2c3d4e5f60718293a4b5c6d7e8f9",
  "name": "Integração da loja",
  "key_prefix": "sk_test_a1B2c3D4e5F6",
  "scopes": [
    "payments:read",
    "payments:write",
    "refunds:write"
  ],
  "status": "revoked",
  "expires_at": "2027-11-06T00:00:00.000Z",
  "last_used_at": null,
  "created_at": "2026-11-06T12:00:00.000Z",
  "revoked_at": "2026-11-06T12:10:00.000Z"
}

Erros