Payments
Merchants

Create a Merchant

Changed on

Enrolls a Merchant with Card Networks.

In rare cases it can take up to 48 hours to enroll a merchant with each of the card networks. If you are still unable to provision network tokens after this period, please contact support@evervault.com

post/payments/merchants

Request

Request body

namestring required

Must be globally unique. We recommend adding a suffix, for example Acme 123456. Onboarding may fail otherwise!

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. Optional. 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).

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

{
  "name": "Acme",
  "shortName": "Acme",
  "website": "https://www.acme.com",
  "categoryCode": "5945",
  "business": {
    "legalName": "Acme Corp",
    "address": {
      "line1": "123 Main St",
      "line2": "Floor 4",
      "city": "Springfield",
      "state": "ny",
      "country": "us"
    }
  },
  "applePay": {
    "domains": [
      "ollivanders.co.uk"
    ]
  },
  "preChargebackAlerts": {
    "ethocaAlert": {
      "descriptors": [
        {
          "descriptor": "ACME LTD",
          "matchType": "STARTS_WITH"
        }
      ]
    },
    "verifiRdr": {
      "bin": "424242",
      "caid": "123456789012345",
      "arns": [
        "12345678901234567890123"
      ]
    }
  },
  "contact": {
    "phoneNumber": "+44 20 7946 0000",
    "email": "owner@ollivanders.co.uk",
    "name": {
      "firstName": "Garrick",
      "lastName": "Ollivander"
    }
  },
  "externalCustomerReference": "00-4bf92f3577b34da6a3ce929d3e0e4736-00f067aa0ba902b7-01"
}

Response

Returns a 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

    • breaking

      the request property / became required

    • breaking

      added the pattern ^(?:https?://[a-z0-9.-]+\.[a-z]{2,63}|www\d{0,3}\.[a-z0-9.-]+\.[a-z]{2,63}|[a-z0-9.-]+\.[a-z]{2,63}/)(?:(?:[^\s()<>:]+|\((?:[^\s()<>:]+|\([^\s()<>:]+\))*\))*(?:\((?:[^\s()<>:]+|\([^\s()<>:]+\))*\)|[^\s!()\[\]{};:'".,<>?«»“”‘’:]))?$ to the request property website

    • breaking

      added the pattern ^[0-9a-zA-Z ]*$ to the request property //

    • breaking

      added the pattern ^[0-9a-zA-Z _\-¡-￿]+$ to the request property //

    • breaking

      added the pattern ^[a-zA-Z0-9 ]{1,60}$ to the request property /

    • breaking

      added the pattern ^[a-zA-Z0-9 ]{1,60}$ to the request property

    • breaking

      added the pattern ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$ to the request property //

    • breaking

      added the pattern ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$ to the request property //

    • warning

      the // request property's maxLength was set to 50

    • warning

      the // request property's maxLength was set to 60

    • warning

      the // request property's maxLength was set to 60

    • warning

      the // request property's maxLength was set to 20

    • warning

      the request property's maxLength was set to 100

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the // response's property pattern ^[0-9a-zA-Z _\-¡-￿]+$ was added for the status

    • info

      the // response's property pattern ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$ was added for the status

    • info

      the // response's property pattern ^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$ was added for the status

    • info

      the // response's property pattern ^[0-9a-zA-Z ]*$ was added for the status

    • info

      the / response's property pattern ^[a-zA-Z0-9 ]{1,60}$ was added for the status

    • info

      the response's property pattern ^[a-zA-Z0-9 ]{1,60}$ was added for the status

    • info

      added the required property /// to the response with the status

    • breaking

      the // request property format changed from no format to iso-3166-1-alpha-2

    • breaking

      the // request property format changed from no format to iso-3166-2-subdivision

    • info

      removed the pattern ^[a-z]{2}$ from the request property //

    • info

      the // response's property pattern ^[a-z]{2}$ was removed for the status