Skip to main content
POST
Criar chave de API

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Nome descritivo da chave (ex.: erp-producao, conciliacao-job).

Required string length: 1 - 100
scopes
enum<string>[]
required

Escopos concedidos — a chave nunca pode fazer mais que o declarado aqui.

Minimum array length: 1
Available options:
iam:manage,
payments:read,
payments:write,
payouts:read,
payouts:write,
refunds:write,
webhooks:manage,
commerce:read,
commerce:write
expiresAt
string<date-time>

Expiração opcional (ISO 8601). Recomendado para chaves de uso temporário.

Response

Default Response

createdAt
string<date-time>
required
environment
enum<string>
required
Available options:
live,
test
expiresAt
string<date-time> | null
required
id
string<uuid>
required
lastUsedAt
string<date-time> | null
required
name
string
required
Required string length: 1 - 100
publicId
string
required
revokedAt
string<date-time> | null
required
scopes
enum<string>[]
required
Minimum array length: 1
Available options:
iam:manage,
payments:read,
payments:write,
payouts:read,
payouts:write,
refunds:write,
webhooks:manage,
commerce:read,
commerce:write
status
enum<string>
required
Available options:
ACTIVE,
EXPIRED,
REVOKED
token
string
required