TBBN.Merchant Platform docs
WORKING

ApiKeys

post/v1/api-keys

Create an API key (ADMIN/OWNER only; production keys require ADMIN+ approval)

Parameters

optional

Request body

FieldTypeRequired
environmentSANDBOX | PRODUCTIONyes
scopesstring[]yes

Response (201)

FieldTypeRequired
idstring (uuid)
merchantIdstring (uuid)
keyPrefixstring
scopesstring[]
environmentSANDBOX | PRODUCTION
statusACTIVE | ROTATED | REVOKED
createdAtstring (date-time)
expiresAtstring,null (date-time)
fullKeystring
get/v1/api-keys

List API keys (never returns the full key, only the prefix)

Parameters

optional
optional

Response (200)

FieldTypeRequired
dataobject[]
nextCursorstringnull
post/v1/api-keys/{id}/rotate

Rotate a key (old key marked ROTATED, still valid for a grace window)

Parameters

idpathrequired
optional

Response (200)

FieldTypeRequired
idstring (uuid)
merchantIdstring (uuid)
keyPrefixstring
scopesstring[]
environmentSANDBOX | PRODUCTION
statusACTIVE | ROTATED | REVOKED
createdAtstring (date-time)
expiresAtstring,null (date-time)
fullKeystring
delete/v1/api-keys/{id}

Revoke a key immediately

Parameters

idpathrequired