Docs
Acessar painel

Chave de API

Dados da chave atual

GEThttps://api.kokupay.com/v1/api-keys/current

Devolve os dados da chave usada na requisição (nunca o segredo). Útil para conferir ambiente e escopos na subida da integração.

GET/v1/api-keys/current
curl -X GET 'https://api.kokupay.com/v1/api-keys/current' \
  -H "Authorization: Bearer $KOKU_API_KEY"
200Resposta
{
  "id": "a9d4e2f7-0b31-4c6e-8f52-3e7a1d9c6b04",
  "name": "Checkout da loja",
  "prefix": "koku_live_3f9a1c2b4d5e",
  "gateway_id": "5f0c2a9e-1b7d-4c3e-9a51-2d8e6f4b7c10",
  "environment": "production",
  "scopes": [
    "charges:read",
    "charges:write",
    "refunds:write",
    "balance:read",
    "statement:read",
    "payouts:read",
    "webhooks:read",
    "webhooks:write"
  ],
  "expires_at": null,
  "created_at": "2026-10-07T14:00:00.000Z"
}

Autenticação

Authorization: Bearer <sua chave de API>

Qualquer chave válida (nenhum escopo específico). Veja Chaves de API.

Resposta 200

idstring (uuid)

Identificador da chave.

namestring

Nome dado à chave no painel.

prefixstring

Prefixo público da chave (o segredo nunca é devolvido).

gateway_idstring (uuid)

Identificador da sua conta na Koku.

environmentstring

Ambiente da chave: production (sandbox está reservado para o ambiente de testes, em preparação).

Valores: sandbox, production

scopeslista de string

Escopos concedidos.

expires_atstring (data e hora) ou null

Expiração da chave (null = sem expiração).

created_atstring (data e hora)

Criação da chave.

Erros

StatusCódigoQuando
401unauthorizedChave ausente, inválida, revogada ou expirada.
429rate_limitedLimite de requisições excedido. Aguarde o tempo de Retry-After.
500internal_errorFalha inesperada. Repita com a mesma Idempotency-Key; persistindo, envie o correlation_id à Koku (veja Suporte).

Formato do corpo de erro em Erros.