Postal address rules
Overview
The PostalAddress object contains address information used during payment initiation, such as street name, building number, postal code, town name, country, and address lines.
In the options, we configured the available PostalAddress fields according to the specifications provided by each bank. Currently, we only validate whether a field is required and a value has been provided. We do not validate:
- Special characters
- Allowed character sets
- Minimum lengths
- Maximum lengths
- Bank-specific formatting rules
Constraints and Validation
As a general recommendation, constraints should be based on the ISO 20022 definition from pain payment file to reduce the risk of rejection by banks.
Recommended Character Set
a-z A-Z 0-9 - / : . , ' <space>
Fields
Fields
| Field | Type | Maximum Length | Character Set | Regex |
|---|---|---|---|---|
| AddressType | Check "Address Type Values" table belo | 4 | A-Z | ^(ADDR|PBOX|HOME|BIZ|MLTO|DLVY)$ |
| Department | Text | 70 | a-z A-Z 0-9 - / : ( ) . , ? ' + space | ^[A-Za-z0-9-/:().,?' ]70 |
| SubDepartment | Text | 70 | a-z A-Z 0-9 - / : ( ) . , ? ' + space | ^[A-Za-z0-9-/:().,?' ]70 |
| StreetName | Text | 70 | a-z A-Z 0-9 - / : ( ) . , ? ' + space | ^[A-Za-z0-9-/:().,?' ]70 |
| BuildingNumber | Text | 16 | a-z A-Z 0-9 - / : ( ) . , ? ' + space | ^[A-Za-z0-9-/:().,?' ]16 |
| PostalCode | Text | 16 | a-z A-Z 0-9 - / : ( ) . , ? ' + space | ^[A-Za-z0-9-/:().,?' ]16 |
| TownName | Text | 35 | a-z A-Z 0-9 - / : ( ) . , ? ' + space | ^[A-Za-z0-9-/:().,?' ]35 |
| CountrySubdivision | Text | 35 | a-z A-Z 0-9 - / : ( ) . , ? ' + space | ^[A-Za-z0-9-/:().,?' ]35 |
| Country | Text | 2 | A-Z | ^[A-Z] |
| AddressLine | Text | 70 | a-z A-Z 0-9 - / : ( ) . , ? ' + space | ^[A-Za-z0-9-/:().,?' ]70 |
Address Type Values
| Code | Description |
|---|---|
| ADDR | Postal Address |
| PBOX | Post Office Box |
| HOME | Residential Address |
| BIZZ | Business Address |
| MLTO | Mail-To Addre |
| DLVY | Delivery Ad |
Updated about 3 hours ago
Did this page help you?
