Skip to content

Get Merchant

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

Returns full detail for a single merchant. The caller may only request their own merchant (the id must equal the JWT merchant_id claim). Payment gateway credentials are never returned.

id
required
string format: uuid

The merchant’s unique identifier.

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
Example generated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"description": "example",
"contactEmail": "example",
"contactPhone": "example",
"country": "example",
"timeZone": "example",
"isActive": true,
"gatewayConfigured": true,
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z"
}

Caller does not belong to the requested merchant.

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

No merchant with the given ID 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"
}