Update Merchant Acceptor
Update a Merchant Acceptor using JSON Merge Patch (RFC 7386). Set a field to null to remove it. Example:
{ "webshopUrl": null }
Requires acceptors:Update permission.
Request
- Base URLhttps://eu-west-1.api.silverflow.com/v1
- Auth
- HTTP basic
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Uniquely identifies a Merchant Acceptor.
Immutable, unique identifier of the merchant acceptor
Request body
Clients not enrolled in the "extended character set beta" are still subject to the ^[\w +=.,:;!?$@()-]+$ pattern for field input.
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.
| Network | Length | Characters | Pattern |
|---|---|---|---|
| AMEX | 1-20 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
| Bancontact | 1-15 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
| Diners | 1-15 | alphanumeric | /^[a-zA-Z0-9# -]+$/ |
| Discover | 1-15 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
| Mastercard | 1-15 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
| Visa | 1-15 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
The Merchant category.
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.
A valid URL
Unique ID assigned by the card network for the merchant. Used for example for Private Label transactions or large merchants.
| Network | Length | Characters |
|---|---|---|
| Mastercard | 6 | alpha numeric |
| Visa | 10 | numeric |
| Bancontact | 6 | numeric |
A key assigned by Silverflow to uniquely identify a Bin.
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.
Unique ID assigned by the acquirer or Payment Facilitator to the subMerchant.
Unique ID assigned by the card network for the Independent Sales Organization. <span class="tag network-tag mastercard-tag">MASTERCARD</span>
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>
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>
Visa provided ID required for marketplaces. If provided, rampProviderId must not be provided. <span class="tag network-tag visa-tag">VISA</span>
Visa provided ID required for ramp providers. If provided, marketplaceId must not be provided. <span class="tag network-tag visa-tag">VISA</span>
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.
User-specified reference.
An optional route key to force route charges
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>
The three-letter ISO code of the currency.
European ISO Currency Codes
<details>| Country — Currency | Code | Numeric | Minor Units |
|---|---|---|---|
| Åland Islands — Euro | EUR | 978 | 2 |
| Andorra — Euro | EUR | 978 | 2 |
| Austria — Euro | EUR | 978 | 2 |
| Belgium — Euro | EUR | 978 | 2 |
| Cyprus — Euro | EUR | 978 | 2 |
| Estonia — Euro | EUR | 978 | 2 |
| European Union — Euro | EUR | 978 | 2 |
| Finland — Euro | EUR | 978 | 2 |
| France — Euro | EUR | 978 | 2 |
| French Guiana — Euro | EUR | 978 | 2 |
| French Southern Territories (The) — Euro | EUR | 978 | 2 |
| Germany — Euro | EUR | 978 | 2 |
| Greece — Euro | EUR | 978 | 2 |
| Guadeloupe — Euro | EUR | 978 | 2 |
| Holy See (The) — Euro | EUR | 978 | 2 |
| Ireland — Euro | EUR | 978 | 2 |
| Italy — Euro | EUR | 978 | 2 |
| Latvia — Euro | EUR | 978 | 2 |
| Lithuania — Euro | EUR | 978 | 2 |
| Luxembourg — Euro | EUR | 978 | 2 |
| Malta — Euro | EUR | 978 | 2 |
| Martinique — Euro | EUR | 978 | 2 |
| Mayotte — Euro | EUR | 978 | 2 |
| Monaco — Euro | EUR | 978 | 2 |
| Montenegro — Euro | EUR | 978 | 2 |
| Netherlands (The) — Euro | EUR | 978 | 2 |
| Portugal — Euro | EUR | 978 | 2 |
| Réunion — Euro | EUR | 978 | 2 |
| Saint Barthélemy — Euro | EUR | 978 | 2 |
| Saint Martin (French Part) — Euro | EUR | 978 | 2 |
| Saint Pierre And Miquelon — Euro | EUR | 978 | 2 |
| San Marino — Euro | EUR | 978 | 2 |
| Slovakia — Euro | EUR | 978 | 2 |
| Slovenia — Euro | EUR | 978 | 2 |
| Spain — Euro | EUR | 978 | 2 |
US ISO Currency Codes
<details>| Country — Currency | Code | Numeric | Minor Units |
|---|---|---|---|
| American Samoa — US Dollar | USD | 840 | 2 |
| Bonaire, Sint Eustatius And Saba — US Dollar | USD | 840 | 2 |
| British Indian Ocean Territory (The) — US Dollar | USD | 840 | 2 |
| Ecuador — US Dollar | USD | 840 | 2 |
| El Salvador — US Dollar | USD | 840 | 2 |
| Guam — US Dollar | USD | 840 | 2 |
| Haiti — US Dollar | USD | 840 | 2 |
| Marshall Islands (The) — US Dollar | USD | 840 | 2 |
| Micronesia (Federated States Of) — US Dollar | USD | 840 | 2 |
| Northern Mariana Islands (The) — US Dollar | USD | 840 | 2 |
| Palau — US Dollar | USD | 840 | 2 |
| Panama — US Dollar | USD | 840 | 2 |
| Puerto Rico — US Dollar | USD | 840 | 2 |
| Timor-leste — US Dollar | USD | 840 | 2 |
| Turks And Caicos Islands (The) — US Dollar | USD | 840 | 2 |
| United States Minor Outlying Islands (The) — US Dollar | USD | 840 | 2 |
| United States Of America (The) — US Dollar | USD | 840 | 2 |
| Virgin Islands (British) — US Dollar | USD | 840 | 2 |
| Virgin Islands (U.s.) — US Dollar | USD | 840 | 2 |
Other ISO Currency Codes
<details>| Country — Currency | Code | Numeric | Minor Units |
|---|---|---|---|
| Afghanistan — Afghani | AFN | 971 | 2 |
| Albania — Lek | ALL | 008 | 2 |
| Algeria — Algerian Dinar | DZD | 012 | 2 |
| Angola — Kwanza | AOA | 973 | 2 |
| Anguilla — East Caribbean Dollar | XCD | 951 | 2 |
| Antigua And Barbuda — East Caribbean Dollar | XCD | 951 | 2 |
| Argentina — Argentine Peso | ARS | 032 | 2 |
| Armenia — Armenian Dram | AMD | 051 | 2 |
| Aruba — Aruban Florin | AWG | 533 | 2 |
| Australia — Australian Dollar | AUD | 036 | 2 |
| Azerbaijan — Azerbaijan Manat | AZN | 944 | 2 |
| Bahamas (The) — Bahamian Dollar | BSD | 044 | 2 |
| Bahrain — Bahraini Dinar | BHD | 048 | 3 |
| Bangladesh — Taka | BDT | 050 | 2 |
| Barbados — Barbados Dollar | BBD | 052 | 2 |
| Belarus — Belarusian Ruble | BYN | 933 | 2 |
| Belize — Belize Dollar | BZD | 084 | 2 |
| Benin — CFA Franc BCEAO | XOF | 952 | 0 |
| Bermuda — Bermudian Dollar | BMD | 060 | 2 |
| Bhutan — Indian Rupee | INR | 356 | 2 |
| Bhutan — Ngultrum | BTN | 064 | 2 |
| Bolivia (Plurinational State Of) — Boliviano | BOB | 068 | 2 |
| Bosnia And Herzegovina — Convertible Mark | BAM | 977 | 2 |
| Botswana — Pula | BWP | 072 | 2 |
| Bouvet Island — Norwegian Krone | NOK | 578 | 2 |
| Brazil — Brazilian Real | BRL | 986 | 2 |
| Brunei Darussalam — Brunei Dollar | BND | 096 | 2 |
| Bulgaria — Bulgarian Lev | BGN | 975 | 2 |
| Burkina Faso — CFA Franc BCEAO | XOF | 952 | 0 |
| Burundi — Burundi Franc | BIF | 108 | 0 |
| Cabo Verde — Cabo Verde Escudo | CVE | 132 | 2 |
| Cambodia — Riel | KHR | 116 | 2 |
| Cameroon — CFA Franc BEAC | XAF | 950 | 0 |
| Canada — Canadian Dollar | CAD | 124 | 2 |
| Cayman Islands (The) — Cayman Islands Dollar | KYD | 136 | 2 |
| Central African Republic (The) — CFA Franc BEAC | XAF | 950 | 0 |
| Chad — CFA Franc BEAC | XAF | 950 | 0 |
| Chile — Chilean Peso | CLP | 152 | 0 |
| China — Yuan Renminbi | CNY | 156 | 2 |
| China — Yuan Renminbi | CNH | 157 | 2 |
| Christmas Island — Australian Dollar | AUD | 036 | 2 |
| Cocos (Keeling) Islands (The) — Australian Dollar | AUD | 036 | 2 |
| Colombia — Colombian Peso | COP | 170 | 2 |
| Comoros (The) — Comorian Franc | KMF | 174 | 0 |
| Congo (The Democratic Republic Of The) — Congolese Franc | CDF | 976 | 2 |
| Congo (The) — CFA Franc BEAC | XAF | 950 | 0 |
| Cook Islands (The) — New Zealand Dollar | NZD | 554 | 2 |
| Costa Rica — Costa Rican Colon | CRC | 188 | 2 |
| Côte D'ivoire — CFA Franc BCEAO | XOF | 952 | 0 |
| Croatia — Kuna | HRK | 191 | 2 |
| Cuba — Cuban Peso | CUP | 192 | 2 |
| Cuba — Peso Convertible | CUC | 931 | 2 |
| Curaçao — Netherlands Antillean Guilder | ANG | 532 | 2 |
| Czechia — Czech Koruna | CZK | 203 | 2 |
| Denmark — Danish Krone | DKK | 208 | 2 |
| Djibouti — Djibouti Franc | DJF | 262 | 0 |
| Dominica — East Caribbean Dollar | XCD | 951 | 2 |
| Dominican Republic (The) — Dominican Peso | DOP | 214 | 2 |
| Egypt — Egyptian Pound | EGP | 818 | 2 |
| El Salvador — El Salvador Colon | SVC | 222 | 2 |
| Equatorial Guinea — CFA Franc BEAC | XAF | 950 | 0 |
| Eritrea — Nakfa | ERN | 232 | 2 |
| Ethiopia — Ethiopian Birr | ETB | 230 | 2 |
| Falkland Islands (The) [Malvinas] — Falkland Islands Pound | FKP | 238 | 2 |
| Faroe Islands (The) — Danish Krone | DKK | 208 | 2 |
| Fiji — Fiji Dollar | FJD | 242 | 2 |
| French Polynesia — CFP Franc | XPF | 953 | 0 |
| Gabon — CFA Franc BEAC | XAF | 950 | 0 |
| Gambia (The) — Dalasi | GMD | 270 | 2 |
| Georgia — Lari | GEL | 981 | 2 |
| Ghana — Ghana Cedi | GHS | 936 | 2 |
| Gibraltar — Gibraltar Pound | GIP | 292 | 2 |
| Greenland — Danish Krone | DKK | 208 | 2 |
| Grenada — East Caribbean Dollar | XCD | 951 | 2 |
| Guatemala — Quetzal | GTQ | 320 | 2 |
| Guernsey — Pound Sterling | GBP | 826 | 2 |
| Guinea — Guinean Franc | GNF | 324 | 0 |
| Guinea-bissau — CFA Franc BCEAO | XOF | 952 | 0 |
| Guyana — Guyana Dollar | GYD | 328 | 2 |
| Haiti — Gourde | HTG | 332 | 2 |
| Heard Island And Mcdonald Islands — Australian Dollar | AUD | 036 | 2 |
| Honduras — Lempira | HNL | 340 | 2 |
| Hong Kong — Hong Kong Dollar | HKD | 344 | 2 |
| Hungary — Forint | HUF | 348 | 2 |
| Iceland — Iceland Krona | ISK | 352 | 0 |
| India — Indian Rupee | INR | 356 | 2 |
| Indonesia — Rupiah | IDR | 360 | 2 |
| Iran (Islamic Republic Of) — Iranian Rial | IRR | 364 | 2 |
| Iraq — Iraqi Dinar | IQD | 368 | 3 |
| Isle Of Man — Pound Sterling | GBP | 826 | 2 |
| Israel — New Israeli Sheqel | ILS | 376 | 2 |
| Jamaica — Jamaican Dollar | JMD | 388 | 2 |
| Japan — Yen | JPY | 392 | 0 |
| Jersey — Pound Sterling | GBP | 826 | 2 |
| Jordan — Jordanian Dinar | JOD | 400 | 3 |
| Kazakhstan — Tenge | KZT | 398 | 2 |
| Kenya — Kenyan Shilling | KES | 404 | 2 |
| Kiribati — Australian Dollar | AUD | 036 | 2 |
| Korea (The Democratic People’s Republic Of) — North Korean Won | KPW | 408 | 2 |
| Korea (The Republic Of) — Won | KRW | 410 | 0 |
| Kuwait — Kuwaiti Dinar | KWD | 414 | 3 |
| Kyrgyzstan — Som | KGS | 417 | 2 |
| Lao People’s Democratic Republic (The) — Lao Kip | LAK | 418 | 2 |
| Lebanon — Lebanese Pound | LBP | 422 | 2 |
| Lesotho — Loti | LSL | 426 | 2 |
| Lesotho — Rand | ZAR | 710 | 2 |
| Liberia — Liberian Dollar | LRD | 430 | 2 |
| Libya — Libyan Dinar | LYD | 434 | 3 |
| Liechtenstein — Swiss Franc | CHF | 756 | 2 |
| Macao — Pataca | MOP | 446 | 2 |
| Macedonia (The Former Yugoslav Republic Of) — Denar | MKD | 807 | 2 |
| Madagascar — Malagasy Ariary | MGA | 969 | 2 |
| Malawi — Malawi Kwacha | MWK | 454 | 2 |
| Malaysia — Malaysian Ringgit | MYR | 458 | 2 |
| Maldives — Rufiyaa | MVR | 462 | 2 |
| Mali — CFA Franc BCEAO | XOF | 952 | 0 |
| Mauritania — Ouguiya | MRU | 929 | 2 |
| Mauritius — Mauritius Rupee | MUR | 480 | 2 |
| Mexico — Mexican Peso | MXN | 484 | 2 |
| Moldova (The Republic Of) — Moldovan Leu | MDL | 498 | 2 |
| Mongolia — Tugrik | MNT | 496 | 2 |
| Montserrat — East Caribbean Dollar | XCD | 951 | 2 |
| Morocco — Moroccan Dirham | MAD | 504 | 2 |
| Mozambique — Mozambique Metical | MZN | 943 | 2 |
| Myanmar — Kyat | MMK | 104 | 2 |
| Namibia — Namibia Dollar | NAD | 516 | 2 |
| Namibia — Rand | ZAR | 710 | 2 |
| Nauru — Australian Dollar | AUD | 036 | 2 |
| Nepal — Nepalese Rupee | NPR | 524 | 2 |
| New Caledonia — CFP Franc | XPF | 953 | 0 |
| New Zealand — New Zealand Dollar | NZD | 554 | 2 |
| Nicaragua — Cordoba Oro | NIO | 558 | 2 |
| Niger (The) — CFA Franc BCEAO | XOF | 952 | 0 |
| Nigeria — Naira | NGN | 566 | 2 |
| Niue — New Zealand Dollar | NZD | 554 | 2 |
| Norfolk Island — Australian Dollar | AUD | 036 | 2 |
| Norway — Norwegian Krone | NOK | 578 | 2 |
| Oman — Rial Omani | OMR | 512 | 3 |
| Pakistan — Pakistan Rupee | PKR | 586 | 2 |
| Panama — Balboa | PAB | 590 | 2 |
| Papua New Guinea — Kina | PGK | 598 | 2 |
| Paraguay — Guarani | PYG | 600 | 0 |
| Peru — Sol | PEN | 604 | 2 |
| Philippines (The) — Philippine Peso | PHP | 608 | 2 |
| Pitcairn — New Zealand Dollar | NZD | 554 | 2 |
| Poland — Zloty | PLN | 985 | 2 |
| Qatar — Qatari Rial | QAR | 634 | 2 |
| Romania — Romanian Leu | RON | 946 | 2 |
| Russian Federation (The) — Russian Ruble | RUB | 643 | 2 |
| Rwanda — Rwanda Franc | RWF | 646 | 0 |
| Saint Helena, Ascension And Tristan Da Cunha — Saint Helena Pound | SHP | 654 | 2 |
| Saint Kitts And Nevis — East Caribbean Dollar | XCD | 951 | 2 |
| Saint Lucia — East Caribbean Dollar | XCD | 951 | 2 |
| Saint Vincent And The Grenadines — East Caribbean Dollar | XCD | 951 | 2 |
| Samoa — Tala | WST | 882 | 2 |
| Sao Tome And Principe — Dobra | STN | 930 | 2 |
| Saudi Arabia — Saudi Riyal | SAR | 682 | 2 |
| Senegal — CFA Franc BCEAO | XOF | 952 | 0 |
| Serbia — Serbian Dinar | RSD | 941 | 2 |
| Seychelles — Seychelles Rupee | SCR | 690 | 2 |
| Sierra Leone — Leone | SLL | 694 | 2 |
| Sierra Leone — Leone | SLE | 925 | 2 |
| Singapore — Singapore Dollar | SGD | 702 | 2 |
| Sint Maarten (Dutch Part) — Netherlands Antillean Guilder | ANG | 532 | 2 |
| Solomon Islands — Solomon Islands Dollar | SBD | 090 | 2 |
| Somalia — Somali Shilling | SOS | 706 | 2 |
| South Africa — Rand | ZAR | 710 | 2 |
| South Sudan — South Sudanese Pound | SSP | 728 | 2 |
| Sri Lanka — Sri Lanka Rupee | LKR | 144 | 2 |
| Sudan (The) — Sudanese Pound | SDG | 938 | 2 |
| Suriname — Surinam Dollar | SRD | 968 | 2 |
| Svalbard And Jan Mayen — Norwegian Krone | NOK | 578 | 2 |
| Eswatini — Lilangeni | SZL | 748 | 2 |
| Sweden — Swedish Krona | SEK | 752 | 2 |
| Switzerland — Swiss Franc | CHF | 756 | 2 |
| Syrian Arab Republic — Syrian Pound | SYP | 760 | 2 |
| Taiwan (Province Of China) — New Taiwan Dollar | TWD | 901 | 2 |
| Tajikistan — Somoni | TJS | 972 | 2 |
| Tanzania, United Republic Of — Tanzanian Shilling | TZS | 834 | 2 |
| Thailand — Baht | THB | 764 | 2 |
| Togo — CFA Franc BCEAO | XOF | 952 | 0 |
| Tokelau — New Zealand Dollar | NZD | 554 | 2 |
| Tonga — Pa’anga | TOP | 776 | 2 |
| Trinidad And Tobago — Trinidad and Tobago Dollar | TTD | 780 | 2 |
| Tunisia — Tunisian Dinar | TND | 788 | 3 |
| Turkey — Turkish Lira | TRY | 949 | 2 |
| Turkmenistan — Turkmenistan New Manat | TMT | 934 | 2 |
| Tuvalu — Australian Dollar | AUD | 036 | 2 |
| Uganda — Uganda Shilling | UGX | 800 | 0 |
| Ukraine — Hryvnia | UAH | 980 | 2 |
| United Arab Emirates (The) — UAE Dirham | AED | 784 | 2 |
| United Kingdom Of Great Britain And Northern Ireland (The) — Pound Sterling | GBP | 826 | 2 |
| Uruguay — Peso Uruguayo | UYU | 858 | 2 |
| Uruguay — Unidad Previsional | UYW | 927 | 4 |
| Uzbekistan — Uzbekistan Sum | UZS | 860 | 2 |
| Vanuatu — Vatu | VUV | 548 | 0 |
| Venezuela (Bolivarian Republic Of) — Bolívar Soberano | VES | 928 | 2 |
| Viet Nam — Dong | VND | 704 | 0 |
| Wallis And Futuna — CFP Franc | XPF | 953 | 0 |
| Western Sahara — Moroccan Dirham | MAD | 504 | 2 |
| Yemen — Yemeni Rial | YER | 886 | 2 |
| Zambia — Zambian Kwacha | ZMW | 967 | 2 |
| Zimbabwe — Zimbabwe Dollar | ZWL | 932 | 2 |
| Zimbabwe — Zimbabwe Gold | ZWG | 924 | 2 |
Example request
{
"mid": "UO2344SDDAUOGS",
"doingBusinessAsName": "ACME Corp.",
"pointOfSaleAddress": {
"countryCode": {
"alpha3": "NLD"
},
"stateOrProvince": "Noord-Holland",
"city": "Amsterdam-Duivendrecht",
"line1": "Entrada 300",
"line2": "Floor 3",
"postalCode": "1114 AA"
},
"binKey": "bin-1iXRhbDjrT2Yxvo0mSZN",
"subMerchantAddress": {
"countryCode": {
"alpha3": "NLD"
},
"stateOrProvince": "Noord-Holland",
"city": "Amsterdam-Duivendrecht",
"line1": "Entrada 300",
"line2": "Floor 3",
"postalCode": "1114 AA"
},
"tags": {
"IamAKey": "ThisIsaValue!"
},
"authorizationCurrency": "EUR"
}Response
The updated Merchant Acceptor version
Uniquely identifies a Merchant Acceptor.
The status of the Acceptor (version)
Clients not enrolled in the "extended character set beta" are still subject to the ^[\w +=.,:;!?$@()-]+$ pattern for field input.
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.
| Network | Length | Characters | Pattern |
|---|---|---|---|
| AMEX | 1-20 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
| Bancontact | 1-15 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
| Diners | 1-15 | alphanumeric | /^[a-zA-Z0-9# -]+$/ |
| Discover | 1-15 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
| Mastercard | 1-15 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
| Visa | 1-15 | alphanumeric | /^[a-zA-Z0-9-_.]+$/ |
The Merchant category.
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.
A valid URL
Unique ID assigned by the card network for the merchant. Used for example for Private Label transactions or large merchants.
| Network | Length | Characters |
|---|---|---|
| Mastercard | 6 | alpha numeric |
| Visa | 10 | numeric |
| Bancontact | 6 | numeric |
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.
Unique ID assigned by the acquirer or Payment Facilitator to the subMerchant.
Unique ID assigned by the card network for the Independent Sales Organization. <span class="tag network-tag mastercard-tag">MASTERCARD</span>
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>
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.
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>
Visa provided ID required for marketplaces. If provided, rampProviderId must not be provided. <span class="tag network-tag visa-tag">VISA</span>
Visa provided ID required for ramp providers. If provided, marketplaceId must not be provided. <span class="tag network-tag visa-tag">VISA</span>
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_"
The date and time this object was created
The date and time this object was last modified
The version of this object
User-specified reference.
An optional route key to force route charges
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>
The three-letter ISO code of the currency.
European ISO Currency Codes
<details>| Country — Currency | Code | Numeric | Minor Units |
|---|---|---|---|
| Åland Islands — Euro | EUR | 978 | 2 |
| Andorra — Euro | EUR | 978 | 2 |
| Austria — Euro | EUR | 978 | 2 |
| Belgium — Euro | EUR | 978 | 2 |
| Cyprus — Euro | EUR | 978 | 2 |
| Estonia — Euro | EUR | 978 | 2 |
| European Union — Euro | EUR | 978 | 2 |
| Finland — Euro | EUR | 978 | 2 |
| France — Euro | EUR | 978 | 2 |
| French Guiana — Euro | EUR | 978 | 2 |
| French Southern Territories (The) — Euro | EUR | 978 | 2 |
| Germany — Euro | EUR | 978 | 2 |
| Greece — Euro | EUR | 978 | 2 |
| Guadeloupe — Euro | EUR | 978 | 2 |
| Holy See (The) — Euro | EUR | 978 | 2 |
| Ireland — Euro | EUR | 978 | 2 |
| Italy — Euro | EUR | 978 | 2 |
| Latvia — Euro | EUR | 978 | 2 |
| Lithuania — Euro | EUR | 978 | 2 |
| Luxembourg — Euro | EUR | 978 | 2 |
| Malta — Euro | EUR | 978 | 2 |
| Martinique — Euro | EUR | 978 | 2 |
| Mayotte — Euro | EUR | 978 | 2 |
| Monaco — Euro | EUR | 978 | 2 |
| Montenegro — Euro | EUR | 978 | 2 |
| Netherlands (The) — Euro | EUR | 978 | 2 |
| Portugal — Euro | EUR | 978 | 2 |
| Réunion — Euro | EUR | 978 | 2 |
| Saint Barthélemy — Euro | EUR | 978 | 2 |
| Saint Martin (French Part) — Euro | EUR | 978 | 2 |
| Saint Pierre And Miquelon — Euro | EUR | 978 | 2 |
| San Marino — Euro | EUR | 978 | 2 |
| Slovakia — Euro | EUR | 978 | 2 |
| Slovenia — Euro | EUR | 978 | 2 |
| Spain — Euro | EUR | 978 | 2 |
US ISO Currency Codes
<details>| Country — Currency | Code | Numeric | Minor Units |
|---|---|---|---|
| American Samoa — US Dollar | USD | 840 | 2 |
| Bonaire, Sint Eustatius And Saba — US Dollar | USD | 840 | 2 |
| British Indian Ocean Territory (The) — US Dollar | USD | 840 | 2 |
| Ecuador — US Dollar | USD | 840 | 2 |
| El Salvador — US Dollar | USD | 840 | 2 |
| Guam — US Dollar | USD | 840 | 2 |
| Haiti — US Dollar | USD | 840 | 2 |
| Marshall Islands (The) — US Dollar | USD | 840 | 2 |
| Micronesia (Federated States Of) — US Dollar | USD | 840 | 2 |
| Northern Mariana Islands (The) — US Dollar | USD | 840 | 2 |
| Palau — US Dollar | USD | 840 | 2 |
| Panama — US Dollar | USD | 840 | 2 |
| Puerto Rico — US Dollar | USD | 840 | 2 |
| Timor-leste — US Dollar | USD | 840 | 2 |
| Turks And Caicos Islands (The) — US Dollar | USD | 840 | 2 |
| United States Minor Outlying Islands (The) — US Dollar | USD | 840 | 2 |
| United States Of America (The) — US Dollar | USD | 840 | 2 |
| Virgin Islands (British) — US Dollar | USD | 840 | 2 |
| Virgin Islands (U.s.) — US Dollar | USD | 840 | 2 |
Other ISO Currency Codes
<details>| Country — Currency | Code | Numeric | Minor Units |
|---|---|---|---|
| Afghanistan — Afghani | AFN | 971 | 2 |
| Albania — Lek | ALL | 008 | 2 |
| Algeria — Algerian Dinar | DZD | 012 | 2 |
| Angola — Kwanza | AOA | 973 | 2 |
| Anguilla — East Caribbean Dollar | XCD | 951 | 2 |
| Antigua And Barbuda — East Caribbean Dollar | XCD | 951 | 2 |
| Argentina — Argentine Peso | ARS | 032 | 2 |
| Armenia — Armenian Dram | AMD | 051 | 2 |
| Aruba — Aruban Florin | AWG | 533 | 2 |
| Australia — Australian Dollar | AUD | 036 | 2 |
| Azerbaijan — Azerbaijan Manat | AZN | 944 | 2 |
| Bahamas (The) — Bahamian Dollar | BSD | 044 | 2 |
| Bahrain — Bahraini Dinar | BHD | 048 | 3 |
| Bangladesh — Taka | BDT | 050 | 2 |
| Barbados — Barbados Dollar | BBD | 052 | 2 |
| Belarus — Belarusian Ruble | BYN | 933 | 2 |
| Belize — Belize Dollar | BZD | 084 | 2 |
| Benin — CFA Franc BCEAO | XOF | 952 | 0 |
| Bermuda — Bermudian Dollar | BMD | 060 | 2 |
| Bhutan — Indian Rupee | INR | 356 | 2 |
| Bhutan — Ngultrum | BTN | 064 | 2 |
| Bolivia (Plurinational State Of) — Boliviano | BOB | 068 | 2 |
| Bosnia And Herzegovina — Convertible Mark | BAM | 977 | 2 |
| Botswana — Pula | BWP | 072 | 2 |
| Bouvet Island — Norwegian Krone | NOK | 578 | 2 |
| Brazil — Brazilian Real | BRL | 986 | 2 |
| Brunei Darussalam — Brunei Dollar | BND | 096 | 2 |
| Bulgaria — Bulgarian Lev | BGN | 975 | 2 |
| Burkina Faso — CFA Franc BCEAO | XOF | 952 | 0 |
| Burundi — Burundi Franc | BIF | 108 | 0 |
| Cabo Verde — Cabo Verde Escudo | CVE | 132 | 2 |
| Cambodia — Riel | KHR | 116 | 2 |
| Cameroon — CFA Franc BEAC | XAF | 950 | 0 |
| Canada — Canadian Dollar | CAD | 124 | 2 |
| Cayman Islands (The) — Cayman Islands Dollar | KYD | 136 | 2 |
| Central African Republic (The) — CFA Franc BEAC | XAF | 950 | 0 |
| Chad — CFA Franc BEAC | XAF | 950 | 0 |
| Chile — Chilean Peso | CLP | 152 | 0 |
| China — Yuan Renminbi | CNY | 156 | 2 |
| China — Yuan Renminbi | CNH | 157 | 2 |
| Christmas Island — Australian Dollar | AUD | 036 | 2 |
| Cocos (Keeling) Islands (The) — Australian Dollar | AUD | 036 | 2 |
| Colombia — Colombian Peso | COP | 170 | 2 |
| Comoros (The) — Comorian Franc | KMF | 174 | 0 |
| Congo (The Democratic Republic Of The) — Congolese Franc | CDF | 976 | 2 |
| Congo (The) — CFA Franc BEAC | XAF | 950 | 0 |
| Cook Islands (The) — New Zealand Dollar | NZD | 554 | 2 |
| Costa Rica — Costa Rican Colon | CRC | 188 | 2 |
| Côte D'ivoire — CFA Franc BCEAO | XOF | 952 | 0 |
| Croatia — Kuna | HRK | 191 | 2 |
| Cuba — Cuban Peso | CUP | 192 | 2 |
| Cuba — Peso Convertible | CUC | 931 | 2 |
| Curaçao — Netherlands Antillean Guilder | ANG | 532 | 2 |
| Czechia — Czech Koruna | CZK | 203 | 2 |
| Denmark — Danish Krone | DKK | 208 | 2 |
| Djibouti — Djibouti Franc | DJF | 262 | 0 |
| Dominica — East Caribbean Dollar | XCD | 951 | 2 |
| Dominican Republic (The) — Dominican Peso | DOP | 214 | 2 |
| Egypt — Egyptian Pound | EGP | 818 | 2 |
| El Salvador — El Salvador Colon | SVC | 222 | 2 |
| Equatorial Guinea — CFA Franc BEAC | XAF | 950 | 0 |
| Eritrea — Nakfa | ERN | 232 | 2 |
| Ethiopia — Ethiopian Birr | ETB | 230 | 2 |
| Falkland Islands (The) [Malvinas] — Falkland Islands Pound | FKP | 238 | 2 |
| Faroe Islands (The) — Danish Krone | DKK | 208 | 2 |
| Fiji — Fiji Dollar | FJD | 242 | 2 |
| French Polynesia — CFP Franc | XPF | 953 | 0 |
| Gabon — CFA Franc BEAC | XAF | 950 | 0 |
| Gambia (The) — Dalasi | GMD | 270 | 2 |
| Georgia — Lari | GEL | 981 | 2 |
| Ghana — Ghana Cedi | GHS | 936 | 2 |
| Gibraltar — Gibraltar Pound | GIP | 292 | 2 |
| Greenland — Danish Krone | DKK | 208 | 2 |
| Grenada — East Caribbean Dollar | XCD | 951 | 2 |
| Guatemala — Quetzal | GTQ | 320 | 2 |
| Guernsey — Pound Sterling | GBP | 826 | 2 |
| Guinea — Guinean Franc | GNF | 324 | 0 |
| Guinea-bissau — CFA Franc BCEAO | XOF | 952 | 0 |
| Guyana — Guyana Dollar | GYD | 328 | 2 |
| Haiti — Gourde | HTG | 332 | 2 |
| Heard Island And Mcdonald Islands — Australian Dollar | AUD | 036 | 2 |
| Honduras — Lempira | HNL | 340 | 2 |
| Hong Kong — Hong Kong Dollar | HKD | 344 | 2 |
| Hungary — Forint | HUF | 348 | 2 |
| Iceland — Iceland Krona | ISK | 352 | 0 |
| India — Indian Rupee | INR | 356 | 2 |
| Indonesia — Rupiah | IDR | 360 | 2 |
| Iran (Islamic Republic Of) — Iranian Rial | IRR | 364 | 2 |
| Iraq — Iraqi Dinar | IQD | 368 | 3 |
| Isle Of Man — Pound Sterling | GBP | 826 | 2 |
| Israel — New Israeli Sheqel | ILS | 376 | 2 |
| Jamaica — Jamaican Dollar | JMD | 388 | 2 |
| Japan — Yen | JPY | 392 | 0 |
| Jersey — Pound Sterling | GBP | 826 | 2 |
| Jordan — Jordanian Dinar | JOD | 400 | 3 |
| Kazakhstan — Tenge | KZT | 398 | 2 |
| Kenya — Kenyan Shilling | KES | 404 | 2 |
| Kiribati — Australian Dollar | AUD | 036 | 2 |
| Korea (The Democratic People’s Republic Of) — North Korean Won | KPW | 408 | 2 |
| Korea (The Republic Of) — Won | KRW | 410 | 0 |
| Kuwait — Kuwaiti Dinar | KWD | 414 | 3 |
| Kyrgyzstan — Som | KGS | 417 | 2 |
| Lao People’s Democratic Republic (The) — Lao Kip | LAK | 418 | 2 |
| Lebanon — Lebanese Pound | LBP | 422 | 2 |
| Lesotho — Loti | LSL | 426 | 2 |
| Lesotho — Rand | ZAR | 710 | 2 |
| Liberia — Liberian Dollar | LRD | 430 | 2 |
| Libya — Libyan Dinar | LYD | 434 | 3 |
| Liechtenstein — Swiss Franc | CHF | 756 | 2 |
| Macao — Pataca | MOP | 446 | 2 |
| Macedonia (The Former Yugoslav Republic Of) — Denar | MKD | 807 | 2 |
| Madagascar — Malagasy Ariary | MGA | 969 | 2 |
| Malawi — Malawi Kwacha | MWK | 454 | 2 |
| Malaysia — Malaysian Ringgit | MYR | 458 | 2 |
| Maldives — Rufiyaa | MVR | 462 | 2 |
| Mali — CFA Franc BCEAO | XOF | 952 | 0 |
| Mauritania — Ouguiya | MRU | 929 | 2 |
| Mauritius — Mauritius Rupee | MUR | 480 | 2 |
| Mexico — Mexican Peso | MXN | 484 | 2 |
| Moldova (The Republic Of) — Moldovan Leu | MDL | 498 | 2 |
| Mongolia — Tugrik | MNT | 496 | 2 |
| Montserrat — East Caribbean Dollar | XCD | 951 | 2 |
| Morocco — Moroccan Dirham | MAD | 504 | 2 |
| Mozambique — Mozambique Metical | MZN | 943 | 2 |
| Myanmar — Kyat | MMK | 104 | 2 |
| Namibia — Namibia Dollar | NAD | 516 | 2 |
| Namibia — Rand | ZAR | 710 | 2 |
| Nauru — Australian Dollar | AUD | 036 | 2 |
| Nepal — Nepalese Rupee | NPR | 524 | 2 |
| New Caledonia — CFP Franc | XPF | 953 | 0 |
| New Zealand — New Zealand Dollar | NZD | 554 | 2 |
| Nicaragua — Cordoba Oro | NIO | 558 | 2 |
| Niger (The) — CFA Franc BCEAO | XOF | 952 | 0 |
| Nigeria — Naira | NGN | 566 | 2 |
| Niue — New Zealand Dollar | NZD | 554 | 2 |
| Norfolk Island — Australian Dollar | AUD | 036 | 2 |
| Norway — Norwegian Krone | NOK | 578 | 2 |
| Oman — Rial Omani | OMR | 512 | 3 |
| Pakistan — Pakistan Rupee | PKR | 586 | 2 |
| Panama — Balboa | PAB | 590 | 2 |
| Papua New Guinea — Kina | PGK | 598 | 2 |
| Paraguay — Guarani | PYG | 600 | 0 |
| Peru — Sol | PEN | 604 | 2 |
| Philippines (The) — Philippine Peso | PHP | 608 | 2 |
| Pitcairn — New Zealand Dollar | NZD | 554 | 2 |
| Poland — Zloty | PLN | 985 | 2 |
| Qatar — Qatari Rial | QAR | 634 | 2 |
| Romania — Romanian Leu | RON | 946 | 2 |
| Russian Federation (The) — Russian Ruble | RUB | 643 | 2 |
| Rwanda — Rwanda Franc | RWF | 646 | 0 |
| Saint Helena, Ascension And Tristan Da Cunha — Saint Helena Pound | SHP | 654 | 2 |
| Saint Kitts And Nevis — East Caribbean Dollar | XCD | 951 | 2 |
| Saint Lucia — East Caribbean Dollar | XCD | 951 | 2 |
| Saint Vincent And The Grenadines — East Caribbean Dollar | XCD | 951 | 2 |
| Samoa — Tala | WST | 882 | 2 |
| Sao Tome And Principe — Dobra | STN | 930 | 2 |
| Saudi Arabia — Saudi Riyal | SAR | 682 | 2 |
| Senegal — CFA Franc BCEAO | XOF | 952 | 0 |
| Serbia — Serbian Dinar | RSD | 941 | 2 |
| Seychelles — Seychelles Rupee | SCR | 690 | 2 |
| Sierra Leone — Leone | SLL | 694 | 2 |
| Sierra Leone — Leone | SLE | 925 | 2 |
| Singapore — Singapore Dollar | SGD | 702 | 2 |
| Sint Maarten (Dutch Part) — Netherlands Antillean Guilder | ANG | 532 | 2 |
| Solomon Islands — Solomon Islands Dollar | SBD | 090 | 2 |
| Somalia — Somali Shilling | SOS | 706 | 2 |
| South Africa — Rand | ZAR | 710 | 2 |
| South Sudan — South Sudanese Pound | SSP | 728 | 2 |
| Sri Lanka — Sri Lanka Rupee | LKR | 144 | 2 |
| Sudan (The) — Sudanese Pound | SDG | 938 | 2 |
| Suriname — Surinam Dollar | SRD | 968 | 2 |
| Svalbard And Jan Mayen — Norwegian Krone | NOK | 578 | 2 |
| Eswatini — Lilangeni | SZL | 748 | 2 |
| Sweden — Swedish Krona | SEK | 752 | 2 |
| Switzerland — Swiss Franc | CHF | 756 | 2 |
| Syrian Arab Republic — Syrian Pound | SYP | 760 | 2 |
| Taiwan (Province Of China) — New Taiwan Dollar | TWD | 901 | 2 |
| Tajikistan — Somoni | TJS | 972 | 2 |
| Tanzania, United Republic Of — Tanzanian Shilling | TZS | 834 | 2 |
| Thailand — Baht | THB | 764 | 2 |
| Togo — CFA Franc BCEAO | XOF | 952 | 0 |
| Tokelau — New Zealand Dollar | NZD | 554 | 2 |
| Tonga — Pa’anga | TOP | 776 | 2 |
| Trinidad And Tobago — Trinidad and Tobago Dollar | TTD | 780 | 2 |
| Tunisia — Tunisian Dinar | TND | 788 | 3 |
| Turkey — Turkish Lira | TRY | 949 | 2 |
| Turkmenistan — Turkmenistan New Manat | TMT | 934 | 2 |
| Tuvalu — Australian Dollar | AUD | 036 | 2 |
| Uganda — Uganda Shilling | UGX | 800 | 0 |
| Ukraine — Hryvnia | UAH | 980 | 2 |
| United Arab Emirates (The) — UAE Dirham | AED | 784 | 2 |
| United Kingdom Of Great Britain And Northern Ireland (The) — Pound Sterling | GBP | 826 | 2 |
| Uruguay — Peso Uruguayo | UYU | 858 | 2 |
| Uruguay — Unidad Previsional | UYW | 927 | 4 |
| Uzbekistan — Uzbekistan Sum | UZS | 860 | 2 |
| Vanuatu — Vatu | VUV | 548 | 0 |
| Venezuela (Bolivarian Republic Of) — Bolívar Soberano | VES | 928 | 2 |
| Viet Nam — Dong | VND | 704 | 0 |
| Wallis And Futuna — CFP Franc | XPF | 953 | 0 |
| Western Sahara — Moroccan Dirham | MAD | 504 | 2 |
| Yemen — Yemeni Rial | YER | 886 | 2 |
| Zambia — Zambian Kwacha | ZMW | 967 | 2 |
| Zimbabwe — Zimbabwe Dollar | ZWL | 932 | 2 |
| Zimbabwe — Zimbabwe Gold | ZWG | 924 | 2 |
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.