Sign in
Merchants

Update the mode of a merchant (live/sandbox)

Update the mode of a merchant (live/sandbox)

patch/api/v1/merchants/{id}/mode

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

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": []
  }
}

Changes

Changed in 3 of the 8 revisions of this API.217

  • b372e7d5563d116See the full diff
    • ▲

      the error/code response's property type/format changed from string/ to / for status 400

      response-property-type-changed

    • ●

      removed the optional property error/errors from the response with the 400 status

      response-optional-property-removed

    • ○

      added the optional property data/country to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/settlement_currency to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property error/metadata to the response with the 400 status

      response-optional-property-added

    • ○

      added subschema #1 subschema #2 to the error/code response property allOf list for the response status 400

      response-property-all-of-added

    • ○

      added the required property data/has_client_secret to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/refund_retention_rate to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6637b341d86d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog