Skip to main content
If a shop delivers to the USA, Canada, or Mexico, PayPal expects the state or province in addition to the address. You collect this information as additional information for the payment method, in one <+CountryRule> section per country. Each entry in the selection list is a <+listentry> subsection. This page contains the three complete lists for you to copy. How to build the surrounding section and what the individual parameters mean is described on the how-to page and in the reference. Guide: PayPal · Guide: Requesting additional information for the payment method · Reference: +CountryRule section

The frame around the lists

Each of the three lists goes in its own <+CountryRule> section within the payment method section. The frame is the same for all three countries; only CountryList-ISO and the entries change.
The country codes for CountryList-ISO are the three-letter codes according to ISO 3166: USA, CAN, and MEX.
The identifier under ID depends on the connection type, not on the country. For the direct connection, it is ws_clearing_paypal_state; for the connection via Computop, it is ws_clearing_computop_paypal_state. It is the same identifier for all three countries, so you create three sections with the same ID and a different CountryList-ISO.The Computop identifier is not mentioned in the previous documentation and is added here.
For both identifiers, the shop automatically sets the reference address to the delivery address and falls back to the billing address if no delivery address was selected. Whatever you enter for UseAddressInput has no effect for these two identifiers.
Only the value from ID is sent to the payment service provider, not the text from Entry-Txt. The abbreviations in the tables below must therefore remain exactly as they are. You may, however, freely change, translate, or spell out the labels without affecting what is transmitted. This is added here.
The first entry with an empty ID is the “Bitte wählen Sie” (please select) placeholder. An empty ID is allowed, but an empty Entry-Txt is not: the shop silently skips entries without a label when reading them in. Together with Required = yes, the placeholder ensures that a missing selection triggers the error message.
A selection list in a <+CountryRule> section holds at most 100 entries. The shop does not read in any further entries. The longest list here, with the 52 entries for the USA plus the placeholder, has 53 lines and stays well below that. This is added here.
Don’t forget the general error message for missing additional information:

USA

52 entries: the 50 states, the federal district, and Puerto Rico.
The list is sorted by name, not by abbreviation. That is why DC is between Delaware and Florida and PR is between Pennsylvania and Rhode Island. The entries appear in the selection field in exactly this order; the shop does not re-sort them.
The list does not include other outlying territories such as Guam or the U.S. Virgin Islands, or the U.S. military mail abbreviations AA, AE, and AP. If you deliver there, add the relevant entries yourself. This is added here.

Canada

13 entries: ten provinces and three territories.
The previous documentation only writes “Newfoundland” for NL. Since 2001, the province has been called “Newfoundland and Labrador”; this is corrected here. The abbreviation NL remains unchanged, because only it is sent to PayPal.

Mexico

32 entries: 31 states and the federal district.
This list is sorted by abbreviation, not by name. In the previous documentation, EM was the only out-of-order entry, placed at the very end; here it has been moved to its place between DG and GR. If searching by name is easier for you, re-sort the entries: the shop outputs them in the order in which they appear in the configuration.
Two labels are taken over unchanged from the previous documentation even though they are outdated: since 2016, DF has been called “Ciudad de México”, and the official name of BC is just “Baja California” without “Norte”. Both abbreviations stay as they are. You can change the labels if your customers expect the current names.
In the listings of the previous documentation, numerous Mexican entries and CA in the USA list have extra spaces after or before the value. The shop removes them when reading in the file, so none of this is visible. They have been removed from the tables above.

For other payment methods too

You need the same list for credit card payments via Computop. With 3-D Secure 2.0, this also requires the state of the delivery address, under the identifier ws_clearing_computop_cc_state. The structure of the section is the same; only the identifier changes. This is added here. Guide: Credit card · Reference: +CountryRule section