Sign in

v1

latestOpenAPI 3.1.02026-07-262343124.1 KB
Merchant Management

Update a merchant

Update a merchant's profile. At least one of merchantName, merchantEmail, or iconUrl must be provided. Pass iconUrl: null to unset the existing logo.

patch/v1/merchants/{merchantId}

Path parameters

merchantIdstring required

Request body

merchantNamestring

Updated display name

merchantEmailstring email

Updated contact email

iconUrlstring uri nullable

Updated logo URL (HTTPS only), or null to unset

Example request

{
  "merchantName": "Acme Store v2",
  "merchantEmail": "new-billing@acme.store",
  "iconUrl": "https://example.com/new-logo.png"
}

Response

Merchant updated

Example response

{
  "merchant": {
    "id": "mrch_7kBz2qR9xPvLmN4Yw",
    "email": "billing@acme.store",
    "status": "active",
    "iconUrl": "https://imagedelivery.net/example/acme-icon.png",
    "createdAt": "2025-06-15T10:30:00.000Z"
  }
}