Skip to main content

ApiKeyResponse

successbooleanrequired
data object

Response payload for successful operations.

idstring<uuid>required
merchantIdstring<uuid>required
labelstringrequired

Possible values: non-empty and <= 120 characters

keyPrefixstringrequired

Possible values: <= 16 characters

createdAtstring<date-time>required
revokedAtstring<date-time>nullable
errorstring

Machine-readable error code.

messagestring

Human-readable response message.

ApiKeyResponse
{
"success": true,
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "string",
"keyPrefix": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"revokedAt": "2024-07-29T15:51:28.071Z"
},
"error": "string",
"message": "string"
}