Update Merchant

PUT

/api/Merchants/{id}

curl --request PUT \
  --url https://example.com/api/Merchants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "contactEmail": "hello@example.com", "contactPhone": "example", "country": "example", "timeZone": "example", "isActive": true, "gatewayUsername": "example", "gatewayPassword": "example" }'

Updates the merchant’s profile, status, and payment gateway credentials. Gateway credential fields are write-only. Leave them null to keep the existing values.

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string format: uuid

The merchant’s unique identifier.

Request Body

Updated merchant data.

object

id

string format: uuid

name

required

string

>= 1 characters <= 200 characters

description

string

nullable <= 2000 characters

contactEmail

string format: email

nullable <= 256 characters

contactPhone

string

nullable <= 30 characters

country

string

nullable <= 100 characters

timeZone

string

nullable <= 100 characters

isActive

boolean

gatewayUsername

string

nullable <= 200 characters

gatewayPassword

string

nullable <= 500 characters

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "contactEmail": "hello@example.com",
  "contactPhone": "example",
  "country": "example",
  "timeZone": "example",
  "isActive": true,
  "gatewayUsername": "example",
  "gatewayPassword": "example"
}

object

id

string format: uuid

name

required

string

>= 1 characters <= 200 characters

description

string

nullable <= 2000 characters

contactEmail

string format: email

nullable <= 256 characters

contactPhone

string

nullable <= 30 characters

country

string

nullable <= 100 characters

timeZone

string

nullable <= 100 characters

isActive

boolean

gatewayUsername

string

nullable <= 200 characters

gatewayPassword

string

nullable <= 500 characters

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "contactEmail": "hello@example.com",
  "contactPhone": "example",
  "country": "example",
  "timeZone": "example",
  "isActive": true,
  "gatewayUsername": "example",
  "gatewayPassword": "example"
}

object

id

string format: uuid

name

required

string

>= 1 characters <= 200 characters

description

string

nullable <= 2000 characters

contactEmail

string format: email

nullable <= 256 characters

contactPhone

string

nullable <= 30 characters

country

string

nullable <= 100 characters

timeZone

string

nullable <= 100 characters

isActive

boolean

gatewayUsername

string

nullable <= 200 characters

gatewayPassword

string

nullable <= 500 characters

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "contactEmail": "hello@example.com",
  "contactPhone": "example",
  "country": "example",
  "timeZone": "example",
  "isActive": true,
  "gatewayUsername": "example",
  "gatewayPassword": "example"
}

Responses

200

Merchant updated successfully.

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

400

Validation failed — check the errors object.

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

403

Forbidden

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