WORKING
ApiKeys
post
/v1/api-keysCreate an API key (ADMIN/OWNER only; production keys require ADMIN+ approval)
Parameters
| optional |
Request body
| Field | Type | Required |
|---|---|---|
| environment | SANDBOX | PRODUCTION | yes |
| scopes | string[] | yes |
Response (201)
| Field | Type | Required |
|---|---|---|
| id | string (uuid) | — |
| merchantId | string (uuid) | — |
| keyPrefix | string | — |
| scopes | string[] | — |
| environment | SANDBOX | PRODUCTION | — |
| status | ACTIVE | ROTATED | REVOKED | — |
| createdAt | string (date-time) | — |
| expiresAt | string,null (date-time) | — |
| fullKey | string | — |
get
/v1/api-keysList API keys (never returns the full key, only the prefix)
Parameters
| optional | ||
| optional |
Response (200)
| Field | Type | Required |
|---|---|---|
| data | object[] | — |
| nextCursor | stringnull | — |
post
/v1/api-keys/{id}/rotateRotate a key (old key marked ROTATED, still valid for a grace window)
Parameters
| id | path | required |
| optional |
Response (200)
| Field | Type | Required |
|---|---|---|
| id | string (uuid) | — |
| merchantId | string (uuid) | — |
| keyPrefix | string | — |
| scopes | string[] | — |
| environment | SANDBOX | PRODUCTION | — |
| status | ACTIVE | ROTATED | REVOKED | — |
| createdAt | string (date-time) | — |
| expiresAt | string,null (date-time) | — |
| fullKey | string | — |
delete
/v1/api-keys/{id}Revoke a key immediately
Parameters
| id | path | required |