---
title: "List Merchants"
method: GET
path: "/merchants"
tags: ["Merchants"]
---

# List Merchants

`GET /merchants`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/merchants`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/merchants/get.ts> (a function with typed inputs; its response is checked against the schema)

This operation returns a (paged) list of all Merchants for the authenticated Agent.

Requires `merchants:List` permission.

## Query parameters

- `sortOrder` 'asc' | 'desc'
- `limit` integer
- `offsetToken` string
- `merchantReference` string: Merchant reference number used by the Agent. Must not start with "mct-".

## Response `200`

A (paged) list of Merchants

- MerchantsPage
  - `offsetToken` string
  - `moreItems` boolean
  - `merchants` Merchant[], required
    - `key` string, required: Uniquely identifies a Merchant
    - `status` 'active' | 'archived', required: The status of the Merchant
    - `merchantReference` string: Merchant reference number used by the Agent. Must not start with "mct-".
    - `agentKey` string, required: Uniquely identifies an Agent
    - `name` string, 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.
    - `description` string: The description of the Merchant. Clients not enrolled in the "extended character set beta" are still subject to the `^[\w +=.,:;!?$@()-]+$` pattern for field input.
    - `legalName` string, 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.
    - `registeredAddress` Address, required: A physical postal address
      - `countryCode` CountryCode, required
        - `alpha3` string, required: The ISO code of the country. **European ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 | | Andorra | AD | 020 | | Austria | AT | 040 | | Belgium | BE | 056 | | Cyprus | CY | 196 | | Estonia | EE | 233 | | | Finland | FI | 246 | | France | FR | 250 | | French Guiana | GF | 254 | | French Southern Territories | TF | 260 | | Germany | DE | 280 | | Greece | GR | 300 | | Guadeloupe | GP | 312 | | Ireland | IE | 372 | | Italy | IT | 380 | | Kosovo, United Nations Mission in Kosovo (UNMIK) | QZ | 900 | | Latvia | LV | 428 | | Lithuania | LT | 440 | | Luxembourg | LU | 442 | | Malta | MT | 470 | | Martinique | MQ | 474 | | Mayotte | YT | 175 | | Monaco | MC | 492 | | Montenegro | ME | 499 | | Netherlands | NL | 528 | | Portugal | PT | 620 | | Reunion | RE | 638 | | Saint Barthélemy | BL | 652 | | Saint Martin (French Part) | MF | 663 | | San Marino | SM | 674 | | Slovakia | SK | 703 | | Slovenia | SI | 705 | | Spain | ES | 724 | | St. Pierre and Miquelon | PM | 666 | | Vatican City State (Holy See) | VA | 336 | </details> **US ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | American Samoa | AS | 016 | | Bonaire, St. Eusasius and Saba | BQ | 535 | | British Indian Ocean Territory | IO | 086 | | Ecuador | EC | 218 | | Guam | GU | 316 | | Marshall Islands | MH | 584 | | Micronesia, Federated States of | FM | 583 | | Northern Mariana Islands | MP | 580 | | Palau | PW | 585 | | Palestine, State of | PS | 275 | | Puerto Rico | PR | 630 | | Timor-Leste | TP | 626 | | Turks and Caicos Islands | TC | 796 | | U.S. Minor Outlying Islands | UM | 581 | | United States | US | 840 | | Virgin Islands, British | VG | 092 | | Virgin Islands, U.S. | VI | 850 | </details> **Other ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Afghanistan | AF | 004 | | Albania | AL | 008 | | Algeria | DZ | 012 | | Angola | AO | 024 | | Anguilla | AI | 660 | | Antarctica | AQ | 010 | | Antigua and Barbuda | AG | 028 | | Argentina | AR | 032 | | Armenia | AM | 051 | | Aruba | AW | 533 | | Australia | AU | 036 | | Azerbaijan | AZ | 031 | | Bahamas | BS | 044 | | Bahrain | BH | 048 | | Bangladesh | BD | 050 | | Barbados | BB | 052 | | Belarus | BR | 112 | | Belize | BZ | 084 | | Benin | BJ | 204 | | Bermuda | BM | 060 | | Bhutan | BT | 064 | | Bolivia, Plurinational State of | BO | 068 | | Bosnia and Herzegovina | BA | 070 | | Botswana | BW | 072 | | Bouvet Island | BV | 074 | | Brazil | BR | 076 | | Brunei Darussalam | BN | 096 | | Bulgaria | BG | 100 | | Burkina Faso | BF | 854 | | Burundi | BI | 108 | | Cambodia | KH | 116 | | Cameroon | CM | 120 | | Canada | CA | 124 | | Cape Verde | CV | 132 | | Cayman Islands | KY | 136 | | Central African Republic | CF | 140 | | Chad | TD | 148 | | Chile | CL | 152 | | China | CN | 156 | | Christmas Island | CX | 162 | | Cocos (Keeling) Islands | CC | 166 | | Colombia | CO | 170 | | Comoros | KM | 174 | | Congo | CG | 178 | | Cook Islands | CK | 184 | | Costa Rica | CR | 188 | | Côte D'Ivoire | CI | 384 | | Croatia | HR | 191 | | Cuba | CU | 192 | | Curacao | CW | 531 | | Czech Republic | CZ | 203 | | Democratic Republic of the Congo | CD | 180 | | Denmark | DK | 208 | | Djibouti | DJ | 262 | | Dominica | DM | 212 | | Dominican Republic | DO | 214 | | Egypt | EG | 818 | | El Salvador | SV | 222 | | Equatorial Guinea | GQ | 226 | | Eritrea | ER | 232 | | Ethiopia | ET | 230 | | Falkland Islands (Malvinas) | FK | 238 | | Faroe Islands | FO | 234 | | Fiji | FJ | 242 | | French Polynesia | PF | 258 | | Gabon | GA | 266 | | Gambia | GM | 270 | | Georgia | GE | 268 | | Ghana | GH | 288 | | Gibraltar | GI | 292 | | Greenland | GL | 304 | | Grenada | GD | 308 | | Guatemala | GT | 320 | | Guernsey | GG | 831 | | Guinea | GN | 324 | | Guinea-Bissau | GW | 624 | | Guyana | GY | 328 | | Haiti | HT | 332 | | Heard and McDonald Islands | HM | 334 | | Honduras | HN | 340 | | Hong Kong | HK | 344 | | Hungary | HU | 348 | | Iceland | IS | 352 | | India | IN | 356 | | Indonesia | ID | 360 | | Iraq | IQ | 368 | | Isle of Man | IM | 833 | | Israel | IL | 376 | | Jamaica | JM | 388 | | Japan | JP | 392 | | Jersey | JE | 832 | | Jordan | JO | 400 | | Kazakhstan | KZ | 398 | | Kenya | KE | 404 | | Kiribati | KI | 296 | | Korea, Republic of | KR | 410 | | Kuwait | KW | 414 | | Kyrgyzstan | KG | 417 | | Lao People's Democratic Republic | LA | 418 | | Lebanon | LB | 422 | | Lesotho | LS | 426 | | Liberia | LR | 430 | | Libyan Arab Jamahiriya | LY | 434 | | Liechtenstein | LI | 438 | | Macao | MO | 446 | | Macedonia | MK | 807 | | Madagascar | MG | 450 | | Malawi | MW | 454 | | Malaysia | MY | 458 | | Maldives | MV | 462 | | Mali | ML | 466 | | Mauritania | MR | 478 | | Mauritius | MU | 480 | | Mexico | MX | 484 | | Moldova, Republic of | MD | 498 | | Mongolia | MN | 496 | | Montserrat | MS | 500 | | Morocco | MA | 504 | | Mozambique | MZ | 508 | | Myanmar (effective 1 November 2012) | MM | 104 | | Namibia | NA | 516 | | Nauru | NR | 520 | | Nepal | NP | 524 | | Netherlands Antilles | AN | 530 | | New Caledonia | NC | 540 | | New Zealand | NZ | 554 | | Nicaragua | NI | 558 | | Niger | NE | 562 | | Nigeria | NG | 566 | | Niue | NU | 570 | | Norfolk Island | NF | 574 | | Norway | NO | 578 | | Oman | OM | 512 | | Pakistan | PK | 586 | | Panama | PA | 591 | | Papua New Guinea | PG | 598 | | Paraguay | PY | 600 | | Peru | PE | 604 | | Philippines | PH | 608 | | Pitcairn | PN | 612 | | Poland | PL | 616 | | Qatar | QA | 634 | | Republic of South Sudan | SS | 728 | | Romania | RO | 642 | | Russian Federation | RU | 643 | | Rwanda | RW | 646 | | Samoa | WS | 882 | | Sao Tome and Principe | ST | 678 | | Saudi Arabia | SA | 682 | | Senegal | SN | 686 | | Serbia | RS | 688 | | Seychelles | SC | 690 | | Sierra Leone | SL | 694 | | Singapore | SG | 702 | | Sint Maarten (Dutch Part) | SX | 534 | | Solomon Islands | SB | 090 | | Somalia | SO | 706 | | South Africa | ZA | 710 | | South Georgia and the South Sandwich Islands | GS | 239 | | Sri Lanka | LK | 144 | | Saint Helena, Ascension and Tristan Da Cunha | SH | 654 | | St. Kitts and Nevis | KN | 659 | | St. Lucia | LC | 662 | | St. Vincent and the Grenadines | VC | 670 | | Suriname | SR | 740 | | Svalbard and Jan Mayen | SJ | 744 | | Swaziland | SZ | 748 | | Sweden | SE | 752 | | Switzerland | CH | 756 | | Taiwan | TW | 158 | | Tajikistan | TJ | 762 | | Tanzania, United Republic of | TZ | 834 | | Thailand | TH | 764 | | Togo | TG | 768 | | Tokelau | TK | 772 | | Tonga | TO | 776 | | Trinidad and Tobago | TT | 780 | | Tunisia | TN | 788 | | Turkey | TR | 792 | | Turkmenistan | TM | 795 | | Tuvalu | TV | 798 | | Uganda | UG | 800 | | Ukraine | UA | 804 | | United Arab Emirates | AE | 784 | | United Kingdom | GB | 826 | | Uruguay | UY | 858 | | Uzbekistan | UZ | 860 | | Vanuatu | VU | 548 | | Venezuela, Bolivarian Republic of | VE | 862 | | Vietnam | VN | 704 | | Wallis and Futuna | WF | 876 | | Western Sahara | EH | 732 | | Yemen | YE | 886 | | Zambia | ZM | 894 | | Zimbabwe | ZW | 716 | </details>
        - `alpha2` string, required: The ISO code of the country. **European ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 | | Andorra | AD | 020 | | Austria | AT | 040 | | Belgium | BE | 056 | | Cyprus | CY | 196 | | Estonia | EE | 233 | | | Finland | FI | 246 | | France | FR | 250 | | French Guiana | GF | 254 | | French Southern Territories | TF | 260 | | Germany | DE | 280 | | Greece | GR | 300 | | Guadeloupe | GP | 312 | | Ireland | IE | 372 | | Italy | IT | 380 | | Kosovo, United Nations Mission in Kosovo (UNMIK) | QZ | 900 | | Latvia | LV | 428 | | Lithuania | LT | 440 | | Luxembourg | LU | 442 | | Malta | MT | 470 | | Martinique | MQ | 474 | | Mayotte | YT | 175 | | Monaco | MC | 492 | | Montenegro | ME | 499 | | Netherlands | NL | 528 | | Portugal | PT | 620 | | Reunion | RE | 638 | | Saint Barthélemy | BL | 652 | | Saint Martin (French Part) | MF | 663 | | San Marino | SM | 674 | | Slovakia | SK | 703 | | Slovenia | SI | 705 | | Spain | ES | 724 | | St. Pierre and Miquelon | PM | 666 | | Vatican City State (Holy See) | VA | 336 | </details> **US ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | American Samoa | AS | 016 | | Bonaire, St. Eusasius and Saba | BQ | 535 | | British Indian Ocean Territory | IO | 086 | | Ecuador | EC | 218 | | Guam | GU | 316 | | Marshall Islands | MH | 584 | | Micronesia, Federated States of | FM | 583 | | Northern Mariana Islands | MP | 580 | | Palau | PW | 585 | | Palestine, State of | PS | 275 | | Puerto Rico | PR | 630 | | Timor-Leste | TP | 626 | | Turks and Caicos Islands | TC | 796 | | U.S. Minor Outlying Islands | UM | 581 | | United States | US | 840 | | Virgin Islands, British | VG | 092 | | Virgin Islands, U.S. | VI | 850 | </details> **Other ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Afghanistan | AF | 004 | | Albania | AL | 008 | | Algeria | DZ | 012 | | Angola | AO | 024 | | Anguilla | AI | 660 | | Antarctica | AQ | 010 | | Antigua and Barbuda | AG | 028 | | Argentina | AR | 032 | | Armenia | AM | 051 | | Aruba | AW | 533 | | Australia | AU | 036 | | Azerbaijan | AZ | 031 | | Bahamas | BS | 044 | | Bahrain | BH | 048 | | Bangladesh | BD | 050 | | Barbados | BB | 052 | | Belarus | BR | 112 | | Belize | BZ | 084 | | Benin | BJ | 204 | | Bermuda | BM | 060 | | Bhutan | BT | 064 | | Bolivia, Plurinational State of | BO | 068 | | Bosnia and Herzegovina | BA | 070 | | Botswana | BW | 072 | | Bouvet Island | BV | 074 | | Brazil | BR | 076 | | Brunei Darussalam | BN | 096 | | Bulgaria | BG | 100 | | Burkina Faso | BF | 854 | | Burundi | BI | 108 | | Cambodia | KH | 116 | | Cameroon | CM | 120 | | Canada | CA | 124 | | Cape Verde | CV | 132 | | Cayman Islands | KY | 136 | | Central African Republic | CF | 140 | | Chad | TD | 148 | | Chile | CL | 152 | | China | CN | 156 | | Christmas Island | CX | 162 | | Cocos (Keeling) Islands | CC | 166 | | Colombia | CO | 170 | | Comoros | KM | 174 | | Congo | CG | 178 | | Cook Islands | CK | 184 | | Costa Rica | CR | 188 | | Côte D'Ivoire | CI | 384 | | Croatia | HR | 191 | | Cuba | CU | 192 | | Curacao | CW | 531 | | Czech Republic | CZ | 203 | | Democratic Republic of the Congo | CD | 180 | | Denmark | DK | 208 | | Djibouti | DJ | 262 | | Dominica | DM | 212 | | Dominican Republic | DO | 214 | | Egypt | EG | 818 | | El Salvador | SV | 222 | | Equatorial Guinea | GQ | 226 | | Eritrea | ER | 232 | | Ethiopia | ET | 230 | | Falkland Islands (Malvinas) | FK | 238 | | Faroe Islands | FO | 234 | | Fiji | FJ | 242 | | French Polynesia | PF | 258 | | Gabon | GA | 266 | | Gambia | GM | 270 | | Georgia | GE | 268 | | Ghana | GH | 288 | | Gibraltar | GI | 292 | | Greenland | GL | 304 | | Grenada | GD | 308 | | Guatemala | GT | 320 | | Guernsey | GG | 831 | | Guinea | GN | 324 | | Guinea-Bissau | GW | 624 | | Guyana | GY | 328 | | Haiti | HT | 332 | | Heard and McDonald Islands | HM | 334 | | Honduras | HN | 340 | | Hong Kong | HK | 344 | | Hungary | HU | 348 | | Iceland | IS | 352 | | India | IN | 356 | | Indonesia | ID | 360 | | Iraq | IQ | 368 | | Isle of Man | IM | 833 | | Israel | IL | 376 | | Jamaica | JM | 388 | | Japan | JP | 392 | | Jersey | JE | 832 | | Jordan | JO | 400 | | Kazakhstan | KZ | 398 | | Kenya | KE | 404 | | Kiribati | KI | 296 | | Korea, Republic of | KR | 410 | | Kuwait | KW | 414 | | Kyrgyzstan | KG | 417 | | Lao People's Democratic Republic | LA | 418 | | Lebanon | LB | 422 | | Lesotho | LS | 426 | | Liberia | LR | 430 | | Libyan Arab Jamahiriya | LY | 434 | | Liechtenstein | LI | 438 | | Macao | MO | 446 | | Macedonia | MK | 807 | | Madagascar | MG | 450 | | Malawi | MW | 454 | | Malaysia | MY | 458 | | Maldives | MV | 462 | | Mali | ML | 466 | | Mauritania | MR | 478 | | Mauritius | MU | 480 | | Mexico | MX | 484 | | Moldova, Republic of | MD | 498 | | Mongolia | MN | 496 | | Montserrat | MS | 500 | | Morocco | MA | 504 | | Mozambique | MZ | 508 | | Myanmar (effective 1 November 2012) | MM | 104 | | Namibia | NA | 516 | | Nauru | NR | 520 | | Nepal | NP | 524 | | Netherlands Antilles | AN | 530 | | New Caledonia | NC | 540 | | New Zealand | NZ | 554 | | Nicaragua | NI | 558 | | Niger | NE | 562 | | Nigeria | NG | 566 | | Niue | NU | 570 | | Norfolk Island | NF | 574 | | Norway | NO | 578 | | Oman | OM | 512 | | Pakistan | PK | 586 | | Panama | PA | 591 | | Papua New Guinea | PG | 598 | | Paraguay | PY | 600 | | Peru | PE | 604 | | Philippines | PH | 608 | | Pitcairn | PN | 612 | | Poland | PL | 616 | | Qatar | QA | 634 | | Republic of South Sudan | SS | 728 | | Romania | RO | 642 | | Russian Federation | RU | 643 | | Rwanda | RW | 646 | | Samoa | WS | 882 | | Sao Tome and Principe | ST | 678 | | Saudi Arabia | SA | 682 | | Senegal | SN | 686 | | Serbia | RS | 688 | | Seychelles | SC | 690 | | Sierra Leone | SL | 694 | | Singapore | SG | 702 | | Sint Maarten (Dutch Part) | SX | 534 | | Solomon Islands | SB | 090 | | Somalia | SO | 706 | | South Africa | ZA | 710 | | South Georgia and the South Sandwich Islands | GS | 239 | | Sri Lanka | LK | 144 | | Saint Helena, Ascension and Tristan Da Cunha | SH | 654 | | St. Kitts and Nevis | KN | 659 | | St. Lucia | LC | 662 | | St. Vincent and the Grenadines | VC | 670 | | Suriname | SR | 740 | | Svalbard and Jan Mayen | SJ | 744 | | Swaziland | SZ | 748 | | Sweden | SE | 752 | | Switzerland | CH | 756 | | Taiwan | TW | 158 | | Tajikistan | TJ | 762 | | Tanzania, United Republic of | TZ | 834 | | Thailand | TH | 764 | | Togo | TG | 768 | | Tokelau | TK | 772 | | Tonga | TO | 776 | | Trinidad and Tobago | TT | 780 | | Tunisia | TN | 788 | | Turkey | TR | 792 | | Turkmenistan | TM | 795 | | Tuvalu | TV | 798 | | Uganda | UG | 800 | | Ukraine | UA | 804 | | United Arab Emirates | AE | 784 | | United Kingdom | GB | 826 | | Uruguay | UY | 858 | | Uzbekistan | UZ | 860 | | Vanuatu | VU | 548 | | Venezuela, Bolivarian Republic of | VE | 862 | | Vietnam | VN | 704 | | Wallis and Futuna | WF | 876 | | Western Sahara | EH | 732 | | Yemen | YE | 886 | | Zambia | ZM | 894 | | Zimbabwe | ZW | 716 | </details>
        - `numeric` string, required: The ISO code of the country. **European ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 | | Andorra | AD | 020 | | Austria | AT | 040 | | Belgium | BE | 056 | | Cyprus | CY | 196 | | Estonia | EE | 233 | | | Finland | FI | 246 | | France | FR | 250 | | French Guiana | GF | 254 | | French Southern Territories | TF | 260 | | Germany | DE | 280 | | Greece | GR | 300 | | Guadeloupe | GP | 312 | | Ireland | IE | 372 | | Italy | IT | 380 | | Kosovo, United Nations Mission in Kosovo (UNMIK) | QZ | 900 | | Latvia | LV | 428 | | Lithuania | LT | 440 | | Luxembourg | LU | 442 | | Malta | MT | 470 | | Martinique | MQ | 474 | | Mayotte | YT | 175 | | Monaco | MC | 492 | | Montenegro | ME | 499 | | Netherlands | NL | 528 | | Portugal | PT | 620 | | Reunion | RE | 638 | | Saint Barthélemy | BL | 652 | | Saint Martin (French Part) | MF | 663 | | San Marino | SM | 674 | | Slovakia | SK | 703 | | Slovenia | SI | 705 | | Spain | ES | 724 | | St. Pierre and Miquelon | PM | 666 | | Vatican City State (Holy See) | VA | 336 | </details> **US ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | American Samoa | AS | 016 | | Bonaire, St. Eusasius and Saba | BQ | 535 | | British Indian Ocean Territory | IO | 086 | | Ecuador | EC | 218 | | Guam | GU | 316 | | Marshall Islands | MH | 584 | | Micronesia, Federated States of | FM | 583 | | Northern Mariana Islands | MP | 580 | | Palau | PW | 585 | | Palestine, State of | PS | 275 | | Puerto Rico | PR | 630 | | Timor-Leste | TP | 626 | | Turks and Caicos Islands | TC | 796 | | U.S. Minor Outlying Islands | UM | 581 | | United States | US | 840 | | Virgin Islands, British | VG | 092 | | Virgin Islands, U.S. | VI | 850 | </details> **Other ISO Country Codes** <details> | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Afghanistan | AF | 004 | | Albania | AL | 008 | | Algeria | DZ | 012 | | Angola | AO | 024 | | Anguilla | AI | 660 | | Antarctica | AQ | 010 | | Antigua and Barbuda | AG | 028 | | Argentina | AR | 032 | | Armenia | AM | 051 | | Aruba | AW | 533 | | Australia | AU | 036 | | Azerbaijan | AZ | 031 | | Bahamas | BS | 044 | | Bahrain | BH | 048 | | Bangladesh | BD | 050 | | Barbados | BB | 052 | | Belarus | BR | 112 | | Belize | BZ | 084 | | Benin | BJ | 204 | | Bermuda | BM | 060 | | Bhutan | BT | 064 | | Bolivia, Plurinational State of | BO | 068 | | Bosnia and Herzegovina | BA | 070 | | Botswana | BW | 072 | | Bouvet Island | BV | 074 | | Brazil | BR | 076 | | Brunei Darussalam | BN | 096 | | Bulgaria | BG | 100 | | Burkina Faso | BF | 854 | | Burundi | BI | 108 | | Cambodia | KH | 116 | | Cameroon | CM | 120 | | Canada | CA | 124 | | Cape Verde | CV | 132 | | Cayman Islands | KY | 136 | | Central African Republic | CF | 140 | | Chad | TD | 148 | | Chile | CL | 152 | | China | CN | 156 | | Christmas Island | CX | 162 | | Cocos (Keeling) Islands | CC | 166 | | Colombia | CO | 170 | | Comoros | KM | 174 | | Congo | CG | 178 | | Cook Islands | CK | 184 | | Costa Rica | CR | 188 | | Côte D'Ivoire | CI | 384 | | Croatia | HR | 191 | | Cuba | CU | 192 | | Curacao | CW | 531 | | Czech Republic | CZ | 203 | | Democratic Republic of the Congo | CD | 180 | | Denmark | DK | 208 | | Djibouti | DJ | 262 | | Dominica | DM | 212 | | Dominican Republic | DO | 214 | | Egypt | EG | 818 | | El Salvador | SV | 222 | | Equatorial Guinea | GQ | 226 | | Eritrea | ER | 232 | | Ethiopia | ET | 230 | | Falkland Islands (Malvinas) | FK | 238 | | Faroe Islands | FO | 234 | | Fiji | FJ | 242 | | French Polynesia | PF | 258 | | Gabon | GA | 266 | | Gambia | GM | 270 | | Georgia | GE | 268 | | Ghana | GH | 288 | | Gibraltar | GI | 292 | | Greenland | GL | 304 | | Grenada | GD | 308 | | Guatemala | GT | 320 | | Guernsey | GG | 831 | | Guinea | GN | 324 | | Guinea-Bissau | GW | 624 | | Guyana | GY | 328 | | Haiti | HT | 332 | | Heard and McDonald Islands | HM | 334 | | Honduras | HN | 340 | | Hong Kong | HK | 344 | | Hungary | HU | 348 | | Iceland | IS | 352 | | India | IN | 356 | | Indonesia | ID | 360 | | Iraq | IQ | 368 | | Isle of Man | IM | 833 | | Israel | IL | 376 | | Jamaica | JM | 388 | | Japan | JP | 392 | | Jersey | JE | 832 | | Jordan | JO | 400 | | Kazakhstan | KZ | 398 | | Kenya | KE | 404 | | Kiribati | KI | 296 | | Korea, Republic of | KR | 410 | | Kuwait | KW | 414 | | Kyrgyzstan | KG | 417 | | Lao People's Democratic Republic | LA | 418 | | Lebanon | LB | 422 | | Lesotho | LS | 426 | | Liberia | LR | 430 | | Libyan Arab Jamahiriya | LY | 434 | | Liechtenstein | LI | 438 | | Macao | MO | 446 | | Macedonia | MK | 807 | | Madagascar | MG | 450 | | Malawi | MW | 454 | | Malaysia | MY | 458 | | Maldives | MV | 462 | | Mali | ML | 466 | | Mauritania | MR | 478 | | Mauritius | MU | 480 | | Mexico | MX | 484 | | Moldova, Republic of | MD | 498 | | Mongolia | MN | 496 | | Montserrat | MS | 500 | | Morocco | MA | 504 | | Mozambique | MZ | 508 | | Myanmar (effective 1 November 2012) | MM | 104 | | Namibia | NA | 516 | | Nauru | NR | 520 | | Nepal | NP | 524 | | Netherlands Antilles | AN | 530 | | New Caledonia | NC | 540 | | New Zealand | NZ | 554 | | Nicaragua | NI | 558 | | Niger | NE | 562 | | Nigeria | NG | 566 | | Niue | NU | 570 | | Norfolk Island | NF | 574 | | Norway | NO | 578 | | Oman | OM | 512 | | Pakistan | PK | 586 | | Panama | PA | 591 | | Papua New Guinea | PG | 598 | | Paraguay | PY | 600 | | Peru | PE | 604 | | Philippines | PH | 608 | | Pitcairn | PN | 612 | | Poland | PL | 616 | | Qatar | QA | 634 | | Republic of South Sudan | SS | 728 | | Romania | RO | 642 | | Russian Federation | RU | 643 | | Rwanda | RW | 646 | | Samoa | WS | 882 | | Sao Tome and Principe | ST | 678 | | Saudi Arabia | SA | 682 | | Senegal | SN | 686 | | Serbia | RS | 688 | | Seychelles | SC | 690 | | Sierra Leone | SL | 694 | | Singapore | SG | 702 | | Sint Maarten (Dutch Part) | SX | 534 | | Solomon Islands | SB | 090 | | Somalia | SO | 706 | | South Africa | ZA | 710 | | South Georgia and the South Sandwich Islands | GS | 239 | | Sri Lanka | LK | 144 | | Saint Helena, Ascension and Tristan Da Cunha | SH | 654 | | St. Kitts and Nevis | KN | 659 | | St. Lucia | LC | 662 | | St. Vincent and the Grenadines | VC | 670 | | Suriname | SR | 740 | | Svalbard and Jan Mayen | SJ | 744 | | Swaziland | SZ | 748 | | Sweden | SE | 752 | | Switzerland | CH | 756 | | Taiwan | TW | 158 | | Tajikistan | TJ | 762 | | Tanzania, United Republic of | TZ | 834 | | Thailand | TH | 764 | | Togo | TG | 768 | | Tokelau | TK | 772 | | Tonga | TO | 776 | | Trinidad and Tobago | TT | 780 | | Tunisia | TN | 788 | | Turkey | TR | 792 | | Turkmenistan | TM | 795 | | Tuvalu | TV | 798 | | Uganda | UG | 800 | | Ukraine | UA | 804 | | United Arab Emirates | AE | 784 | | United Kingdom | GB | 826 | | Uruguay | UY | 858 | | Uzbekistan | UZ | 860 | | Vanuatu | VU | 548 | | Venezuela, Bolivarian Republic of | VE | 862 | | Vietnam | VN | 704 | | Wallis and Futuna | WF | 876 | | Western Sahara | EH | 732 | | Yemen | YE | 886 | | Zambia | ZM | 894 | | Zimbabwe | ZW | 716 | </details>
      - `stateOrProvince` string: The state (US) or province (non-US) of the address. Required for US Point of Sale (POS) acceptors. 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.
      - `city` string, required: The city of the address. 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.
      - `line1` string, required: Address line 1. 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.
      - `line2` string: Address line 2. 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.
      - `postalCode` string, required: The postal code of the address. Clients not enrolled in the "extended character set beta" are still subject to the `^[A-Z0-9]+(\ [A-Z0-9]*)?$` pattern for field input.
    - `customerInquiry` string, required: An international phone number
    - `websiteUrl` string, required: A valid URL
    - `tags` Tags: 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_"
    - `created` string, date-time, required: The date and time this object was created
    - `lastModified` string, date-time: The date and time this object was last modified
    - `version` integer, required: The version of this object
    - `taxRegistrationId` string: 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.
    - `sellerEmail` string: 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.

## Other responses

- `400`: The request was malformed. See the response body for details
- `401`: Authentication information is missing or invalid
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `404`: The requested resource was not found
- `429`: The number of requests (per minute) has exceeded the configured maximum

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)