Merchant Acceptors

Activate Merchant Acceptor

This operation activates the latest draft Merchant Acceptor.

Requires acceptors:Activate permission.

patch/acceptors/{acceptorKey}/versions/draft

Request

Path parameters

acceptorKeystring required

Uniquely identifies a Merchant Acceptor.

Example:mac-1JRadf2ffdfrdPMf2XrS2

Immutable, unique identifier of the merchant acceptor

Request body

status'active' required

Response

The referenced Merchant Acceptor version

keystring required

Uniquely identifies a Merchant Acceptor.

status'draft' | 'active' | 'archived' required

The status of the Acceptor (version)

descriptionstring required

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

midstring required

As per card network requirements, the Merchant ID assigned by the acquirer must uniquely identify a legal merchant per acquirer BIN.

Note: For AMEX merchant acceptors, either provide Seller ID of a seller onboarded by a Payfac, or SE number of an AMEX Direct Merchant.

NetworkLengthCharactersPattern
AMEX1-20alphanumeric/^[a-zA-Z0-9-_.]+$/
Bancontact1-15alphanumeric/^[a-zA-Z0-9-_.]+$/
Diners1-15alphanumeric/^[a-zA-Z0-9# -]+$/
Discover1-15alphanumeric/^[a-zA-Z0-9-_.]+$/
Mastercard1-15alphanumeric/^[a-zA-Z0-9-_.]+$/
Visa1-15alphanumeric/^[a-zA-Z0-9-_.]+$/
mccstring required

The Merchant category.

doingBusinessAsNamestring required

Assumed, trade or fictitious name of the merchant. The name will be trimmed if greater than 25 (Visa) or 22 (Mastercard) characters by the card network. 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.

webshopUrlstring

A valid URL

networkAssignedIdstring

Unique ID assigned by the card network for the merchant. Used for example for Private Label transactions or large merchants.

NetworkLengthCharacters
Mastercard6alpha numeric
Visa10numeric
Bancontact6numeric
acquirerOrPayFacBusinessIdstring

Unique ID assigned by the card network for the Payment Facilitator or the acquirer (<span class="tag network-tag visa-tag">VISA</span>) that signed up the merchant.
Note: Mastercard only uses numeric characters in this field, Visa uses alphanumeric characters.

subMerchantIdstring

Unique ID assigned by the acquirer or Payment Facilitator to the subMerchant.

isoIdstring

Unique ID assigned by the card network for the Independent Sales Organization. <span class="tag network-tag mastercard-tag">MASTERCARD</span>

gatewayIdstring

Merchant Payment Gateway ID (MPG ID). MPG ID is assigned by Mastercard at the time of registration of the MPG as a Service Provider. The value 999998 must be used for MGP ID field if the MPG is wholly owned by the Acquirer. The value 999997 must be used in the MPG ID field if the Merchant uses no gateway and connects directly to the Acquirer. In case no value is provided, 999998 is used by Silverflow where applicable. <span class="tag network-tag mastercard-tag">MASTERCARD</span>

chargesBlockedboolean

A value of true prohibits charges and card management actions from being created using this Acceptor. If the property is absent upon Acceptor creation a value of false is assumed.

foreignRetailerboolean

Applicable for Visa Marketplace and Ramp Provider programs only. Indicates if the end merchant is in a different country than the Marketplace or Ramp Provider. <span class="tag network-tag visa-tag">VISA</span>

marketplaceIdstring

Visa provided ID required for marketplaces. If provided, rampProviderId must not be provided. <span class="tag network-tag visa-tag">VISA</span>

rampProviderIdstring

Visa provided ID required for ramp providers. If provided, marketplaceId must not be provided. <span class="tag network-tag visa-tag">VISA</span>

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

referencestring

User-specified reference.

routestring

An optional route key to force route charges

merchantVolumeIndicatorstring

The Merchant Volume Indicator (MVI) is a Visa assigned field used to classify merchants based on their Visa transaction volume. This field is optional for Visa Merchant Acceptors in the US region. <span class="tag network-tag visa-tag">VISA</span>

authorizationCurrency'EUR' | 'USD' | 'AFN' | 'ALL' | 'DZD' | 'AOA' | 'XCD' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'AZN' | 'BSD' | 'BHD' | 'BDT' | 'BBD' | 'BYN' | 'BZD' | 'XOF' | 'BMD' | 'INR' | 'BTN' | 'BOB' | 'BAM' | 'BWP' | 'NOK' | 'BRL' | 'BND' | 'BGN' | 'BIF' | 'CVE' | 'KHR' | 'XAF' | 'CAD' | 'KYD' | 'CLP' | 'CNY' | 'CNH' | 'COP' | 'KMF' | 'CDF' | 'NZD' | 'CRC' | 'HRK' | 'CUP' | 'CUC' | 'ANG' | 'CZK' | 'DKK' | 'DJF' | 'DOP' | 'EGP' | 'SVC' | 'ERN' | 'ETB' | 'FKP' | 'FJD' | 'XPF' | 'GMD' | 'GEL' | 'GHS' | 'GIP' | 'GTQ' | 'GBP' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'JOD' | 'KZT' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'ZAR' | 'LRD' | 'LYD' | 'CHF' | 'MOP' | 'MKD' | 'MGA' | 'MWK' | 'MYR' | 'MVR' | 'MRU' | 'MUR' | 'MXN' | 'MDL' | 'MNT' | 'MAD' | 'MZN' | 'MMK' | 'NAD' | 'NPR' | 'NIO' | 'NGN' | 'OMR' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'SHP' | 'WST' | 'STN' | 'SAR' | 'RSD' | 'SCR' | 'SLL' | 'SLE' | 'SGD' | 'SBD' | 'SOS' | 'SSP' | 'LKR' | 'SDG' | 'SRD' | 'SZL' | 'SEK' | 'SYP' | 'TWD' | 'TJS' | 'TZS' | 'THB' | 'TOP' | 'TTD' | 'TND' | 'TRY' | 'TMT' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UYW' | 'UZS' | 'VUV' | 'VES' | 'VND' | 'YER' | 'ZMW' | 'ZWL' | 'ZWG'

The three-letter ISO code of the currency.

European ISO Currency Codes

<details>
Country — CurrencyCodeNumericMinor Units
Åland Islands — EuroEUR9782
Andorra — EuroEUR9782
Austria — EuroEUR9782
Belgium — EuroEUR9782
Cyprus — EuroEUR9782
Estonia — EuroEUR9782
European Union — EuroEUR9782
Finland — EuroEUR9782
France — EuroEUR9782
French Guiana — EuroEUR9782
French Southern Territories (The) — EuroEUR9782
Germany — EuroEUR9782
Greece — EuroEUR9782
Guadeloupe — EuroEUR9782
Holy See (The) — EuroEUR9782
Ireland — EuroEUR9782
Italy — EuroEUR9782
Latvia — EuroEUR9782
Lithuania — EuroEUR9782
Luxembourg — EuroEUR9782
Malta — EuroEUR9782
Martinique — EuroEUR9782
Mayotte — EuroEUR9782
Monaco — EuroEUR9782
Montenegro — EuroEUR9782
Netherlands (The) — EuroEUR9782
Portugal — EuroEUR9782
Réunion — EuroEUR9782
Saint Barthélemy — EuroEUR9782
Saint Martin (French Part) — EuroEUR9782
Saint Pierre And Miquelon — EuroEUR9782
San Marino — EuroEUR9782
Slovakia — EuroEUR9782
Slovenia — EuroEUR9782
Spain — EuroEUR9782
</details>

US ISO Currency Codes

<details>
Country — CurrencyCodeNumericMinor Units
American Samoa — US DollarUSD8402
Bonaire, Sint Eustatius And Saba — US DollarUSD8402
British Indian Ocean Territory (The) — US DollarUSD8402
Ecuador — US DollarUSD8402
El Salvador — US DollarUSD8402
Guam — US DollarUSD8402
Haiti — US DollarUSD8402
Marshall Islands (The) — US DollarUSD8402
Micronesia (Federated States Of) — US DollarUSD8402
Northern Mariana Islands (The) — US DollarUSD8402
Palau — US DollarUSD8402
Panama — US DollarUSD8402
Puerto Rico — US DollarUSD8402
Timor-leste — US DollarUSD8402
Turks And Caicos Islands (The) — US DollarUSD8402
United States Minor Outlying Islands (The) — US DollarUSD8402
United States Of America (The) — US DollarUSD8402
Virgin Islands (British) — US DollarUSD8402
Virgin Islands (U.s.) — US DollarUSD8402
</details>

Other ISO Currency Codes

<details>
Country — CurrencyCodeNumericMinor Units
Afghanistan — AfghaniAFN9712
Albania — LekALL0082
Algeria — Algerian DinarDZD0122
Angola — KwanzaAOA9732
Anguilla — East Caribbean DollarXCD9512
Antigua And Barbuda — East Caribbean DollarXCD9512
Argentina — Argentine PesoARS0322
Armenia — Armenian DramAMD0512
Aruba — Aruban FlorinAWG5332
Australia — Australian DollarAUD0362
Azerbaijan — Azerbaijan ManatAZN9442
Bahamas (The) — Bahamian DollarBSD0442
Bahrain — Bahraini DinarBHD0483
Bangladesh — TakaBDT0502
Barbados — Barbados DollarBBD0522
Belarus — Belarusian RubleBYN9332
Belize — Belize DollarBZD0842
Benin — CFA Franc BCEAOXOF9520
Bermuda — Bermudian DollarBMD0602
Bhutan — Indian RupeeINR3562
Bhutan — NgultrumBTN0642
Bolivia (Plurinational State Of) — BolivianoBOB0682
Bosnia And Herzegovina — Convertible MarkBAM9772
Botswana — PulaBWP0722
Bouvet Island — Norwegian KroneNOK5782
Brazil — Brazilian RealBRL9862
Brunei Darussalam — Brunei DollarBND0962
Bulgaria — Bulgarian LevBGN9752
Burkina Faso — CFA Franc BCEAOXOF9520
Burundi — Burundi FrancBIF1080
Cabo Verde — Cabo Verde EscudoCVE1322
Cambodia — RielKHR1162
Cameroon — CFA Franc BEACXAF9500
Canada — Canadian DollarCAD1242
Cayman Islands (The) — Cayman Islands DollarKYD1362
Central African Republic (The) — CFA Franc BEACXAF9500
Chad — CFA Franc BEACXAF9500
Chile — Chilean PesoCLP1520
China — Yuan RenminbiCNY1562
China — Yuan RenminbiCNH1572
Christmas Island — Australian DollarAUD0362
Cocos (Keeling) Islands (The) — Australian DollarAUD0362
Colombia — Colombian PesoCOP1702
Comoros (The) — Comorian FrancKMF1740
Congo (The Democratic Republic Of The) — Congolese FrancCDF9762
Congo (The) — CFA Franc BEACXAF9500
Cook Islands (The) — New Zealand DollarNZD5542
Costa Rica — Costa Rican ColonCRC1882
Côte D'ivoire — CFA Franc BCEAOXOF9520
Croatia — KunaHRK1912
Cuba — Cuban PesoCUP1922
Cuba — Peso ConvertibleCUC9312
Curaçao — Netherlands Antillean GuilderANG5322
Czechia — Czech KorunaCZK2032
Denmark — Danish KroneDKK2082
Djibouti — Djibouti FrancDJF2620
Dominica — East Caribbean DollarXCD9512
Dominican Republic (The) — Dominican PesoDOP2142
Egypt — Egyptian PoundEGP8182
El Salvador — El Salvador ColonSVC2222
Equatorial Guinea — CFA Franc BEACXAF9500
Eritrea — NakfaERN2322
Ethiopia — Ethiopian BirrETB2302
Falkland Islands (The) [Malvinas] — Falkland Islands PoundFKP2382
Faroe Islands (The) — Danish KroneDKK2082
Fiji — Fiji DollarFJD2422
French Polynesia — CFP FrancXPF9530
Gabon — CFA Franc BEACXAF9500
Gambia (The) — DalasiGMD2702
Georgia — LariGEL9812
Ghana — Ghana CediGHS9362
Gibraltar — Gibraltar PoundGIP2922
Greenland — Danish KroneDKK2082
Grenada — East Caribbean DollarXCD9512
Guatemala — QuetzalGTQ3202
Guernsey — Pound SterlingGBP8262
Guinea — Guinean FrancGNF3240
Guinea-bissau — CFA Franc BCEAOXOF9520
Guyana — Guyana DollarGYD3282
Haiti — GourdeHTG3322
Heard Island And Mcdonald Islands — Australian DollarAUD0362
Honduras — LempiraHNL3402
Hong Kong — Hong Kong DollarHKD3442
Hungary — ForintHUF3482
Iceland — Iceland KronaISK3520
India — Indian RupeeINR3562
Indonesia — RupiahIDR3602
Iran (Islamic Republic Of) — Iranian RialIRR3642
Iraq — Iraqi DinarIQD3683
Isle Of Man — Pound SterlingGBP8262
Israel — New Israeli SheqelILS3762
Jamaica — Jamaican DollarJMD3882
Japan — YenJPY3920
Jersey — Pound SterlingGBP8262
Jordan — Jordanian DinarJOD4003
Kazakhstan — TengeKZT3982
Kenya — Kenyan ShillingKES4042
Kiribati — Australian DollarAUD0362
Korea (The Democratic People’s Republic Of) — North Korean WonKPW4082
Korea (The Republic Of) — WonKRW4100
Kuwait — Kuwaiti DinarKWD4143
Kyrgyzstan — SomKGS4172
Lao People’s Democratic Republic (The) — Lao KipLAK4182
Lebanon — Lebanese PoundLBP4222
Lesotho — LotiLSL4262
Lesotho — RandZAR7102
Liberia — Liberian DollarLRD4302
Libya — Libyan DinarLYD4343
Liechtenstein — Swiss FrancCHF7562
Macao — PatacaMOP4462
Macedonia (The Former Yugoslav Republic Of) — DenarMKD8072
Madagascar — Malagasy AriaryMGA9692
Malawi — Malawi KwachaMWK4542
Malaysia — Malaysian RinggitMYR4582
Maldives — RufiyaaMVR4622
Mali — CFA Franc BCEAOXOF9520
Mauritania — OuguiyaMRU9292
Mauritius — Mauritius RupeeMUR4802
Mexico — Mexican PesoMXN4842
Moldova (The Republic Of) — Moldovan LeuMDL4982
Mongolia — TugrikMNT4962
Montserrat — East Caribbean DollarXCD9512
Morocco — Moroccan DirhamMAD5042
Mozambique — Mozambique MeticalMZN9432
Myanmar — KyatMMK1042
Namibia — Namibia DollarNAD5162
Namibia — RandZAR7102
Nauru — Australian DollarAUD0362
Nepal — Nepalese RupeeNPR5242
New Caledonia — CFP FrancXPF9530
New Zealand — New Zealand DollarNZD5542
Nicaragua — Cordoba OroNIO5582
Niger (The) — CFA Franc BCEAOXOF9520
Nigeria — NairaNGN5662
Niue — New Zealand DollarNZD5542
Norfolk Island — Australian DollarAUD0362
Norway — Norwegian KroneNOK5782
Oman — Rial OmaniOMR5123
Pakistan — Pakistan RupeePKR5862
Panama — BalboaPAB5902
Papua New Guinea — KinaPGK5982
Paraguay — GuaraniPYG6000
Peru — SolPEN6042
Philippines (The) — Philippine PesoPHP6082
Pitcairn — New Zealand DollarNZD5542
Poland — ZlotyPLN9852
Qatar — Qatari RialQAR6342
Romania — Romanian LeuRON9462
Russian Federation (The) — Russian RubleRUB6432
Rwanda — Rwanda FrancRWF6460
Saint Helena, Ascension And Tristan Da Cunha — Saint Helena PoundSHP6542
Saint Kitts And Nevis — East Caribbean DollarXCD9512
Saint Lucia — East Caribbean DollarXCD9512
Saint Vincent And The Grenadines — East Caribbean DollarXCD9512
Samoa — TalaWST8822
Sao Tome And Principe — DobraSTN9302
Saudi Arabia — Saudi RiyalSAR6822
Senegal — CFA Franc BCEAOXOF9520
Serbia — Serbian DinarRSD9412
Seychelles — Seychelles RupeeSCR6902
Sierra Leone — LeoneSLL6942
Sierra Leone — LeoneSLE9252
Singapore — Singapore DollarSGD7022
Sint Maarten (Dutch Part) — Netherlands Antillean GuilderANG5322
Solomon Islands — Solomon Islands DollarSBD0902
Somalia — Somali ShillingSOS7062
South Africa — RandZAR7102
South Sudan — South Sudanese PoundSSP7282
Sri Lanka — Sri Lanka RupeeLKR1442
Sudan (The) — Sudanese PoundSDG9382
Suriname — Surinam DollarSRD9682
Svalbard And Jan Mayen — Norwegian KroneNOK5782
Eswatini — LilangeniSZL7482
Sweden — Swedish KronaSEK7522
Switzerland — Swiss FrancCHF7562
Syrian Arab Republic — Syrian PoundSYP7602
Taiwan (Province Of China) — New Taiwan DollarTWD9012
Tajikistan — SomoniTJS9722
Tanzania, United Republic Of — Tanzanian ShillingTZS8342
Thailand — BahtTHB7642
Togo — CFA Franc BCEAOXOF9520
Tokelau — New Zealand DollarNZD5542
Tonga — Pa’angaTOP7762
Trinidad And Tobago — Trinidad and Tobago DollarTTD7802
Tunisia — Tunisian DinarTND7883
Turkey — Turkish LiraTRY9492
Turkmenistan — Turkmenistan New ManatTMT9342
Tuvalu — Australian DollarAUD0362
Uganda — Uganda ShillingUGX8000
Ukraine — HryvniaUAH9802
United Arab Emirates (The) — UAE DirhamAED7842
United Kingdom Of Great Britain And Northern Ireland (The) — Pound SterlingGBP8262
Uruguay — Peso UruguayoUYU8582
Uruguay — Unidad PrevisionalUYW9274
Uzbekistan — Uzbekistan SumUZS8602
Vanuatu — VatuVUV5480
Venezuela (Bolivarian Republic Of) — Bolívar SoberanoVES9282
Viet Nam — DongVND7040
Wallis And Futuna — CFP FrancXPF9530
Western Sahara — Moroccan DirhamMAD5042
Yemen — Yemeni RialYER8862
Zambia — Zambian KwachaZMW9672
Zimbabwe — Zimbabwe DollarZWL9322
Zimbabwe — Zimbabwe GoldZWG9242
</details>

Example response

{
  "key": "mac-1JRadf2ffdfrdPMf2XrS2",
  "mid": "UO2344SDDAUOGS",
  "doingBusinessAsName": "ACME Corp.",
  "webshopUrl": "https://acme.com",
  "pointOfSaleAddress": {
    "countryCode": {
      "alpha3": "NLD",
      "alpha2": "NL",
      "numeric": "528"
    },
    "stateOrProvince": "Noord-Holland",
    "city": "Amsterdam-Duivendrecht",
    "line1": "Entrada 300",
    "line2": "Floor 3",
    "postalCode": "1114 AA"
  },
  "bin": {
    "key": "bin-1iXRhbDjrT2Yxvo0mSZN",
    "status": "active",
    "description": "Example Acquirer - Mastercard",
    "acquirerIdCode": 222222,
    "acquirerBin": 555555,
    "acquirerCountryCode": {
      "alpha3": "DEU",
      "alpha2": "DE",
      "numeric": "276"
    },
    "acquirerAgentKey": "cgt-1nUP5yspouqwUHYSZo9V",
    "network": "mastercard",
    "messageSystem": "DMS",
    "shared": false,
    "created": "2020-08-24T14:15:22.014Z",
    "lastModified": "2020-08-24T21:39:01.957Z",
    "version": 2
  },
  "merchant": {
    "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"
  },
  "subMerchantAddress": {
    "countryCode": {
      "alpha3": "NLD",
      "alpha2": "NL",
      "numeric": "528"
    },
    "stateOrProvince": "Noord-Holland",
    "city": "Amsterdam-Duivendrecht",
    "line1": "Entrada 300",
    "line2": "Floor 3",
    "postalCode": "1114 AA"
  },
  "tags": {
    "IamAKey": "ThisIsaValue!"
  },
  "authorizationCurrency": "EUR"
}

Changes

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