Skip to content

Get Current Merchant

GET
/api/Merchants/me
curl --request GET \
--url https://example.com/api/Merchants/me \
--header 'Authorization: Bearer <token>'

Returns the merchant linked to the signed-in user, derived from the JWT.

Merchant detail.

Media type application/json
object
id
string format: uuid
name
string
nullable
description
string
nullable
contactEmail
string
nullable
contactPhone
string
nullable
country
string
nullable
timeZone
string
nullable
isActive
boolean
gatewayConfigured
boolean
createdAt
string format: date-time
updatedAt
string format: date-time
paychoiceEnvironment
string
Allowed values: Staging Production
merchantGuidConfigured
boolean
paychoiceMerchantProfileId
string
nullable
billingRetryOffsetsDays
string
nullable
billingTerminalAction
string
Allowed values: Cancel Suspend
bankSettlementWindowDays
integer format: int32
Example
{
"paychoiceEnvironment": "Staging",
"billingTerminalAction": "Cancel"
}

No valid token on the request.

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"
}

Merchant referenced by the token no longer exists.

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"
}