v1

latestOpenAPI 3.1.02026-07-262343124.1 KB
Merchant Management

Create a merchant

Create a new merchant under the authenticated partner. Requires an Idempotency-Key header so retries safely return the originally-created merchant rather than creating duplicates.

post/v1/merchants

Headers

Idempotency-Keystring required

Unique key to ensure idempotent request processing. Max 255 characters.

Request body

merchantNamestring required

Display name for the merchant

merchantEmailstring email required

Contact email for the merchant

iconUrlstring uri nullable

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

Example request

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

Response

Merchant created

Example response

{
  "merchant": {
    "id": "mrch_7kBz2qR9xPvLmN4Yw",
    "email": "billing@acme.store",
    "status": "active",
    "createdAt": "2025-06-15T10:30:00.000Z"
  }
}