Structured addresses
Vitesse uses a structured postal address model aligned to ISO 20022.
Use this format wherever a postal address is required, for example for recipient mailing addresses.
The Vitesse address model uses a hybrid address structure, combining mandatory structured address fields with optional address lines.
Address structure rules
For street information, provide either:
StreetNameandBuildingNumber, with one optional entry inAddressLinesfor additional information such as a suite number, floor, unit, building name, or department.- Up to two
AddressLineswhenStreetNameandBuildingNumberare not available. For example:AddressLines: [ "Suite 46", "Floor 5" ]
You must provide the mandatory fields listed below, whether you use structured street fields or address lines.
Structured address fields
- For APIs, use the API field column.
- For batch files, use the CSV header column.
Fields marked with * are mandatory. Bracketed asterisks (*) are for mandatory parameters with exceptions.
| API field | CSV header | Definition | Example |
|---|---|---|---|
StreetName(*) | RecipientAddressStreetName(*) | The street name. Provide this field together with BuildingNumber unless you are using address lines instead. | Main Street |
BuildingNumber(*) | RecipientAddressBuildingNumber(*) | The building or street number. Provide this field together with StreetName unless you are using address lines instead. | 742 |
TownName* | RecipientAddressTownName* | The city or town. | Springfield |
PostCode(*) | RecipientAddressPostCode* | The postal or ZIP code (maximum 10 characters). Required except for the countries listed under Countries without a mandatory postcode (see below). | 62704 |
CountrySubDivision(*) | RecipientAddressCountrySubDivision* | The two-character state code. Required only when Country is AU, CN, IE, JP, or US. Otherwise optional. | IL |
Country* | RecipientAddressCountry* | The two-character ISO 3166-1 alpha-2 country code. For cheques, you must use US. | US |
AddressLines [ ](*)See Address structure rules above. | RecipientAddressLine1(*) | Additional address detail (for example, floor, unit, building name, or department), or the street alternative when structured street fields are not provided. | Suite 46 |
| RecipientAddressLine2 | Optional additional complimentary address detail. Do not provide this field when StreetName and BuildingNumber are supplied. | Floor 5 | |
| The following fields apply only to postal recipient addresses for cheque payments: | |||
Name | PostalRecipientName(*) | The addressee name when the postal recipient is an individual. This value is printed as the For Attention Of name on the envelope. Provide either Name or CompanyName, not both. | Michael Thompson |
CompanyName | PostalRecipientCompanyName(*) | The addressee name when the postal recipient is a business. This value is printed as the company name on the envelope. Provide either Name or CompanyName, not both. | Vitesse PSP Limited |
Countries without a mandatory postcode
Vitesse does not require PostCode when Country is one of the following:
| Country | Code |
|---|---|
| Antigua and Barbuda | AG |
| Angola | AO |
| Antarctica | AQ |
| Aruba | AW |
| Burundi | BI |
| Benin | BJ |
| Bolivia | BO |
| The Bahamas | BS |
| Bouvet Island | BV |
| Botswana | BW |
| Belize | BZ |
| Central African Republic | CF |
| Republic of the Congo | CG |
| Côte d’Ivoire | CI |
| Cook Islands | CK |
| Cameroon | CM |
| Curaçao | CW |
| Djibouti | DJ |
| Dominica | DM |
| Eritrea | ER |
| Ethiopia | ET |
| Fiji | FJ |
| Gabon | GA |
| Grenada | GD |
| The Gambia | GM |
| Guinea | GN |
| Equatorial Guinea | GQ |
| Guinea-Bissau | GW |
| Guyana | GY |
| Hong Kong | HK |
| Honduras | HN |
| Jamaica | JM |
| Comoros | KM |
| Saint Kitts and Nevis | KN |
| North Korea | KP |
| Macao | MO |
| Mauritania | MR |
| Panama | PA |
| Qatar | QA |
| Rwanda | RW |
| Solomon Islands | SB |
| Seychelles | SC |
| Sudan | SD |
| Sierra Leone | SL |
| Somalia | SO |
| Suriname | SR |
| South Sudan | SS |
| São Tomé and Príncipe | ST |
| Sint Maarten (Dutch part) | SX |
| Syria | SY |
| Chad | TD |
| French Southern Territories | TF |
| Togo | TG |
| Tokelau | TK |
| Timor-Leste | TL |
| Tonga | TO |
| Tuvalu | TV |
| United Arab Emirates | AE |
| Vanuatu | VU |
| Yemen | YE |
| Zambia | ZM |
| Zimbabwe | ZW |
Updated 4 days ago