Skip to content

Act As Merchant

POST
/api/admin/merchants/{id}/act-as
curl --request POST \
--url https://example.com/api/admin/merchants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/act-as \
--header 'Authorization: Bearer <token>'

Mint a token that lets the calling operator operate as id. The token keeps the operator’s identity + SystemAdmin role but is scoped to the target merchant, so all tenant-scoped endpoints (which key off the merchant_id claim) automatically resolve to it. The portal stores it in a separate cookie; clearing that cookie reverts. Only SystemAdmins reach this (controller policy).

id
required
string format: uuid

OK

Media type application/json

A minted token that scopes the operator to a merchant, plus that merchant’s display name.

object
token
string
nullable
expiresAt
string format: date-time
merchantId
string format: uuid
merchantName
string
nullable
Example generated
{
"token": "example",
"expiresAt": "2026-04-15T12:00:00Z",
"merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"merchantName": "example"
}

Not Found

Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Example generated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}