Country-specific fields in the BillingProfile object
The Drop-In and Checkout API uses country-specific fields to ensure compliance with local regulations and enhance user experience. This document explains the necessary fields for processing billing and shipping information based on the customer's country.
If the BillingProfile.Country contains any of the below countries, ensure the additional field requirements listed under that country are met.
All fields will be contained within the BillingProfile object.
Argentina
If Argentina (AR) is listed as the BillingProfile.Country the following field is required:
BillingProfile.NationalIdentifier: Requires a DNI (Documento Nacional de Identidad).
Brazil
If Brazil (BR) is listed as the BillingProfile.Country the following fields are required:
BillingProfile.NationalIdentifier: Requires a CPF (Cadastro de Pessoas Físicas) or CNPJ (Cadastro Nacional da Pessoa Jurídica). If you provide the CNPJ, include theBillingProfile.Company.BillingProfile.Company: Provide this field if a CNPJ is theBillingProfile.NationalIdentifier.BillingProfile.Birthdate: Provide a valid birthdate in the format: YYYY-MM-DD.BillingProfile.Postcode: Requires an eight-digit numeric Brazilian postal code.
Canada
If Canada (CA) is listed as the BillingProfile.Country the following fields are required:
BillingProfile.Postcode: Requires a valid Canadian postal code (e.g., A1B 2C3).BillingProfile.Region: Requires a two-letter valid Canadian province or territory code. See Canadian regions for a list of valid codes.
Canadian regions
| Value | Description |
|---|---|
| AB | Alberta |
| BC | British Columbia |
| MB | Manitoba |
| NB | New Brunswick |
| NL | Newfoundland and Labrador |
| NS | Nova Scotia |
| NT | Northwest Territories |
| NU | Nunavut |
| ON | Ontario |
| PE | Prince Edward Island |
| QC | Quebec |
| SK | Saskatchewan |
| YT | Yukon |
India
If India (IN) is listed as the BillingProfile.Country the following field is required:
BillingProfile.NationalIdentifier: Requires a PAN (Permanent Account Number), a 10-digit unique identification alphanumeric number.
Mexico
If Mexico (MX) is listed as the BillingProfile.Country the following fields are required:
BillingProfile.NationalIdentifier: expects an RFC (Registro Federal de Contribuyentes) or CURP (Clave Única de Registro de Población).BillingProfile.Postcode: Requires a five-digit numeric Mexican postal code.BillingProfile.Region: Requires a two or three-letter valid Mexican state. See Mexican regions for a list of valid Mexican states.
Mexican regions
| Value | Description |
|---|---|
| AGS | Aguascalientes |
| BC | Baja California |
| BCS | Baja California Sur |
| CAM | Campeche |
| COA | Coahuila |
| COL | Colima |
| CHS | Chiapas |
| CHI | Chihuahua |
| DF | Distrito Federal |
| DGO | Durango |
| GTO | Guanajuato |
| GRO | Guerrero |
| HGO | Hidalgo |
| JAL | Jalisco |
| MEX | Mexico |
| MIC | Michoacan |
| MOR | Morelos |
| NAY | Nayarit |
| NL | Nuevo Leon |
| OAX | Oaxaca |
| PEU | Puebla |
| QRO | Queretaro |
| ROO | Quintana Roo |
| SLP | San Luis Potosi |
| SIN | Sinaloa |
| SON | Sonora |
| TAB | Tabasco |
| TAM | Tamaulipas |
| TLA | Tlaxcala |
| VER | Veracruz |
| YUC | Yucatan |
| ZAC | Zacatecas |
United States
If the United States (US) is listed as the BillingProfile.Country the following fields are required:
BillingProfile.Postcode: Requires a five-digit numeric ZIP code.BillingProfile.Region: Requires a two-letter valid American state/territory. See United States regions for a list of valid American states/territories.
United States regions
| Value | Description |
|---|---|
| AL | Alabama |
| AK | Alaska |
| AZ | Arizona |
| AR | Arkansas |
| CA | California |
| CO | Colorado |
| CT | Connecticut |
| DE | Delaware |
| DC | District of Columbia |
| FL | Florida |
| GA | Georgia |
| HI | Hawaii |
| ID | Idaho |
| IL | Illinois |
| IN | Indiana |
| IA | Iowa |
| KS | Kansas |
| KY | Kentucky |
| LA | Louisiana |
| ME | Maine |
| MD | Maryland |
| MA | Massachusetts |
| MI | Michigan |
| MN | Minnesota |
| MS | Mississippi |
| MO | Missouri |
| MT | Montana |
| NE | Nebraska |
| NV | Nevada |
| NH | New Hampshire |
| NJ | New Jersey |
| NM | New Mexico |
| NY | New York |
| NC | North Carolina |
| ND | North Dakota |
| OH | Ohio |
| OK | Oklahoma |
| OR | Oregon |
| PA | Pennsylvania |
| RI | Rhode Island |
| SC | South Carolina |
| SD | South Dakota |
| TN | Tennessee |
| TX | Texas |
| UT | Utah |
| VT | Vermont |
| VA | Virginia |
| WA | Washington |
| WV | West Virginia |
| WI | Wisconsin |
| WY | Wyoming |
| US | United States Federal |
| IT | International |
| PR | Puerto Rico |
| VI | US Virgin Islands |
| MP | Northern Mariana Islands |
| GU | Guam |
| PW | Palau |
| AA | Armed Forces Americas |
| AE | Armed Forces Europe |
| AP | Armed Forces Pacific |
