v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Merchants

Update a merchant by ID

put/api/v1/merchants/{id}

Path parameters

idstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the merchant

Request body

brand_namestring

The updated brand name of the merchant

uristring

The updated URI of the merchant's website (protocol optional, will be normalized)

category_codestring

The updated merchant category code

countrystring

The country of the merchant

Example request

{
  "brand_name": "Updated Example Brand",
  "uri": "updated-example-merchant.com",
  "category_code": "4816",
  "country": "GB"
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "brand_name": "Example Brand",
    "uri": "https://example-merchant.com",
    "category_code": "4816",
    "country": "GB",
    "settlement_currency": "EUR",
    "multi_account_setting": true,
    "refund_retention_rate": "0.0500",
    "client_id": "merchant_123",
    "has_client_secret": true,
    "account_owners": []
  }
}