SIsilverflow
Merchants

Update Merchant

Requires merchants:Update permission.

patch/merchants/{merchantKey}

Request

Path parameters

merchantKeystring required

Uniquely identifies a Merchant

Example:mct-123dinkqFqfq3q2f2adfa

Immutable, unique identifier of the merchant

Headers

If-Matchinteger

The request condition

Request body

namestring

The display name of the Merchant. Clients not enrolled in the "extended character set beta" are still subject to the ^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-\/]+$ pattern for field input.

descriptionstring

The description of the Merchant. Clients not enrolled in the "extended character set beta" are still subject to the [\w +=.,:;!?$@()-]+ pattern for field input.

legalNamestring

The legal name of the Merchant. Clients not enrolled in the "extended character set beta" are still subject to the ^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-\/]+$ pattern for field input.

customerInquirystring

An international phone number

websiteUrlstring

A valid URL

merchantReferencestring

Merchant reference number used by the Agent. Must not start with "mct-".

tagsTags

Optional tags provided by the agent to tag the object for maintainability. Tags can be used filtering and sorting on the list views of entities. Tag object can contain 10 properties at most. A valid tag-key must:

  • contain only a-z, 0-9, "_" characters
  • first character should be a letter
  • be at least 1 character long
  • be no longer than 24 characters
  • not start with "sf_"
taxRegistrationIdstring

A unique identifier assigned to individuals or entities for tax-related purposes. The format, name and use of this id may vary depending on the country and card network. <br> Visa requires all acquirers to include the SIRET for France or the Tax Identification Number for Belgium and Luxembourg for all domestic transactions. <br> Mastercard and Discover require the Tax Id Number in the US for commercial card transactions.

sellerEmailstring

A valid email address

businessType'corporation' | 'sole_proprietorship' | 'partnership' | 'non_profit_organization' | 'government_agency' | 'limited_liability_company'

The business type of the merchant. Specifying the businessType for your legal entity may qualify the merchant to benefit from lower interchange fees in the United States (Mastercard and Visa). <br> For US merchants, Mastercard requires this field for commercial card transactions. If none of the values closely match your business type please contact your Technical Account Manager.

Example request

{
  "registeredAddress": {
    "countryCode": {
      "alpha3": "NLD"
    },
    "stateOrProvince": "Noord-Holland",
    "city": "Amsterdam-Duivendrecht",
    "line1": "Entrada 300",
    "line2": "Floor 3",
    "postalCode": "1114 AA"
  },
  "customerInquiry": "+31850609160",
  "tags": {
    "IamAKey": "ThisIsaValue!"
  }
}

Response

The updated Merchant

keystring required

Uniquely identifies a Merchant

status'active' | 'archived' required

The status of the Merchant

merchantReferencestring

Merchant reference number used by the Agent. Must not start with "mct-".

agentKeystring required

Uniquely identifies an Agent

namestring required

The display name of the Merchant. Clients not enrolled in the "extended character set beta" are still subject to the ^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-\/]+$ pattern for field input.

descriptionstring

The description of the Merchant. Clients not enrolled in the "extended character set beta" are still subject to the ^[\w +=.,:;!?$@()-]+$ pattern for field input.

legalNamestring required

The legal name of the Merchant. Clients not enrolled in the "extended character set beta" are still subject to the ^[\w ,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-\/]+$ pattern for field input.

customerInquirystring required

An international phone number

websiteUrlstring required

A valid URL

tagsTags

Optional tags provided by the agent to tag the object for maintainability. Tags can be used filtering and sorting on the list views of entities. Tag object can contain 10 properties at most. A valid tag-key must:

  • contain only a-z, 0-9, "_" characters
  • first character should be a letter
  • be at least 1 character long
  • be no longer than 24 characters
  • not start with "sf_"
createdstring date-time required

The date and time this object was created

lastModifiedstring date-time

The date and time this object was last modified

versioninteger required

The version of this object

taxRegistrationIdstring

A unique identifier assigned to individuals or entities for tax-related purposes. The format, name and use of this id may vary depending on the country and card network. <br> Visa requires all acquirers to include the SIRET for France or the Tax Identification Number for Belgium and Luxembourg for all domestic transactions. <br> Mastercard and Discover require the Tax Id Number in the US for commercial card transactions.

sellerEmailstring

A valid email address

businessType'corporation' | 'sole_proprietorship' | 'partnership' | 'non_profit_organization' | 'government_agency' | 'limited_liability_company'

The business type of the merchant. Specifying the businessType for your legal entity may qualify the merchant to benefit from lower interchange fees in the United States (Mastercard and Visa). <br> For US merchants, Mastercard requires this field for commercial card transactions. If none of the values closely match your business type please contact your Technical Account Manager.

Example response

{
  "key": "mct-1hPdFhmgaBzMS191nIbJ",
  "status": "active",
  "agentKey": "cgt-1hPdFhmgaBzMS85d4QcG",
  "merchantReference": "AB1234-5678_10.31",
  "name": "ACME Corporation A/S",
  "description": "ACME Corporation. Building materials, rockets and birdseed.",
  "legalName": "ACME Corp. A/S",
  "registeredAddress": {
    "countryCode": {
      "alpha3": "USA",
      "alpha2": "US",
      "numeric": 528
    },
    "stateOrProvince": "CA",
    "city": "Hill Valley",
    "line1": "Riverside Drive 1640",
    "postalCode": "91103"
  },
  "customerInquiry": "+15554321",
  "websiteUrl": "https://acme.com/catalog/acme.html",
  "created": "2021-05-27T10:57:52Z",
  "lastModified": "2021-05-27T10:57:52Z",
  "version": 1,
  "sellerEmail": "seller@gmail.com",
  "taxRegistrationId": "US1234567890",
  "businessType": "corporation"
}

Changes

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