Country-specific fields

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 the BillingProfile.Company.
  • BillingProfile.Company: Provide this field if a CNPJ is the BillingProfile.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

ValueDescription
ABAlberta
BCBritish Columbia
MBManitoba
NBNew Brunswick
NLNewfoundland and Labrador
NSNova Scotia
NTNorthwest Territories
NUNunavut
ONOntario
PEPrince Edward Island
QCQuebec
SKSaskatchewan
YTYukon

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

ValueDescription
AGSAguascalientes
BCBaja California
BCSBaja California Sur
CAMCampeche
COACoahuila
COLColima
CHSChiapas
CHIChihuahua
DFDistrito Federal
DGODurango
GTOGuanajuato
GROGuerrero
HGOHidalgo
JALJalisco
MEXMexico
MICMichoacan
MORMorelos
NAYNayarit
NLNuevo Leon
OAXOaxaca
PEUPuebla
QROQueretaro
ROOQuintana Roo
SLPSan Luis Potosi
SINSinaloa
SONSonora
TABTabasco
TAMTamaulipas
TLATlaxcala
VERVeracruz
YUCYucatan
ZACZacatecas

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

ValueDescription
ALAlabama
AKAlaska
AZArizona
ARArkansas
CACalifornia
COColorado
CTConnecticut
DEDelaware
DCDistrict of Columbia
FLFlorida
GAGeorgia
HIHawaii
IDIdaho
ILIllinois
INIndiana
IAIowa
KSKansas
KYKentucky
LALouisiana
MEMaine
MDMaryland
MAMassachusetts
MIMichigan
MNMinnesota
MSMississippi
MOMissouri
MTMontana
NENebraska
NVNevada
NHNew Hampshire
NJNew Jersey
NMNew Mexico
NYNew York
NCNorth Carolina
NDNorth Dakota
OHOhio
OKOklahoma
OROregon
PAPennsylvania
RIRhode Island
SCSouth Carolina
SDSouth Dakota
TNTennessee
TXTexas
UTUtah
VTVermont
VAVirginia
WAWashington
WVWest Virginia
WIWisconsin
WYWyoming
USUnited States Federal
ITInternational
PRPuerto Rico
VIUS Virgin Islands
MPNorthern Mariana Islands
GUGuam
PWPalau
AAArmed Forces Americas
AEArmed Forces Europe
APArmed Forces Pacific