EVevervault
Payments
Merchants

Update a Merchant

Updates a Merchant by its unique identifier.

patch/payments/merchants/{merchant_id}

Request

Path parameters

merchant_idstring required

The id of the Merchant to be updated.

Request body

shortNamestring

A shorter version of the Merchant's name. When creating a 3D Secure session that references this Merchant by ID, shortName is used in place of name if name exceeds the 40-character limit imposed by the 3D Secure specification.

externalCustomerReferencestring

An optional reference of your choice, such as a correlation ID, that is attached to the request. The reference will be visible in your logs. Must be between 1 and 255 characters.

Example request

{
  "shortName": "Acme",
  "applePay": {
    "domains": [
      "ollivanders.co.uk"
    ]
  },
  "preChargebackAlerts": {
    "ethocaAlert": {
      "descriptors": [
        {
          "descriptor": "ACME LTD",
          "matchType": "STARTS_WITH"
        }
      ]
    },
    "verifiRdr": {
      "bin": "424242",
      "caid": "123456789012345",
      "arns": [
        "12345678901234567890123"
      ]
    },
    "enabled": true
  },
  "contact": {
    "phoneNumber": "+44 20 7946 0000",
    "email": "owner@ollivanders.co.uk",
    "name": {
      "firstName": "Garrick",
      "lastName": "Ollivander"
    }
  },
  "externalCustomerReference": "00-4bf92f3577b34da6a3ce929d3e0e4736-00f067aa0ba902b7-01"
}

Response

Returns the updated Merchant object.

idstring required

A unique identifier assigned to each Merchant.

namestring required

Must be globally unique. We recommend adding a suffix, for example Acme 123456.

The official name of the Merchant as recognized in transactions and communications. This name is used for display purposes and may be the company's trade name or a derived nickname.

shortNamestring

A shorter version of the Merchant's name. When creating a 3D Secure session that references this Merchant by ID, shortName is used in place of name if name exceeds the 40-character limit imposed by the 3D Secure specification.

websitestring required

The official website URL of the Merchant. The domain must use a valid IANA top-level domain. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt

categoryCodestring required

The 4-digit Merchant Category Code (MCC).

createdAtinteger required

The exact time, in epoch milliseconds, when this Merchant was created.

updatedAtinteger

The exact time, in epoch milliseconds, when this Merchant was last updated.

Example response

{
  "id": "merchant_eead1d640d7c",
  "name": "Ollivanders Wand Shop",
  "website": "https://www.ollivanders.co.uk",
  "categoryCode": "5945",
  "business": {
    "legalName": "Ollivanders Wand Shop Ltd",
    "address": {
      "line1": "Diagon Alley",
      "city": "London",
      "postalCode": "WD1 1AA",
      "country": "gb"
    }
  },
  "networkTokens": {
    "enrolment": [
      {
        "cardBrand": "mastercard",
        "tokenRequestorIdentifier": "50165156978",
        "status": "active"
      },
      {
        "cardBrand": "visa",
        "tokenRequestorIdentifier": "40238123804",
        "status": "active"
      },
      {
        "cardBrand": "american-express",
        "tokenRequestorIdentifier": null,
        "status": "inactive"
      }
    ]
  },
  "applePay": {
    "domains": [
      {
        "merchantUuid": "merchant_eead1d640d7c",
        "domain": "store.ollivanders.co.uk",
        "status": "active"
      }
    ]
  },
  "createdAt": 1692972623233,
  "updatedAt": 1692972623768
}

Changes

No recorded changes to this operation across all 1 revision of this API.