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.

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string format: uuid

The merchant’s unique identifier.

Responses

200

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

403

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

404

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