- Created by PAYONE Admin on 2019-05-03
Verification and correction of address details.
The verification of the address is carried out to minimize the risk of non-payment and to correct the entered address information. Deviations in the address details are corrected automatically.
This request is only available if module “protect” has been ordered.
For best results please provide “streetname” and “streetnumber” in separate fields. If not possible you can use “street” only.
For “addresscheck person” first-/last name is obviously mandatory. Parameter “gender” and “birthday” are optional but recommended for best results.
The response address fields are corrected if applicable.
Request "addresscheck" | ||||||||||||||||||
Common Parameter | Required | Format | Comment | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+ |
Sub-Account ID, defined by PAYONE Format NUMERIC(5..6)
| |||||||||||||||||
+ |
Specifies type of address check to be performed Format LIST
| |||||||||||||||||
o |
First name of customer; optional if company is used, i.e.: you may use
Format CHAR(1..50)
| |||||||||||||||||
o |
Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50)
| |||||||||||||||||
- |
Company name of customer; The company name is optional if lastname is used, i.e.: you may use
Format CHAR(2..50)
| |||||||||||||||||
o |
Street number and name (required: at least one character) Format CHAR(1..50)
| |||||||||||||||||
o |
Street name Format CHAR(1..50)
| |||||||||||||||||
o |
Street number Format CHAR(1..50)
| |||||||||||||||||
+ |
Postcode Format CHAR(2..10) Permitted Symbols
[0-9][A-Z][a-z][
| |||||||||||||||||
+ |
City of customer Format CHAR(2..50)
| |||||||||||||||||
+ | ||||||||||||||||||
- |
Date of birth of customer Format DATE(8), YYYYMMDD Samples 20190101 19991231
| |||||||||||||||||
- |
Phone number of customer Format CHAR(1..30)
| |||||||||||||||||
- |
Gender of customer (female / male / diverse* ) Format LIST Permitted values f m d * currently not in use
| |||||||||||||||||
- |
Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. Format LIST Permitted values ISO 639-1 (Language) 2-letter-codes
| |||||||||||||||||
Response "addresscheck" | |||||||||||||||
Common Parameter | Required | Format | Comment | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | + | Default | VALID / INVALID / ERROR | ||||||||||||
Parameter (VALID) - address valid | |||||||||||||||
+ |
Response code of address check to return whether address has been corrected Format LIST
| ||||||||||||||
+ | Default | Person address check result; details see code list (“Parameters for address check person returns”)
Person address check result; details Format LIST
| |||||||||||||
- |
First name of customer; optional if company is used, i.e.: you may use
Format CHAR(1..50)
| ||||||||||||||
- |
Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50)
| ||||||||||||||
+ |
Street number and name (required: at least one character) Format CHAR(1..50)
| ||||||||||||||
- |
Street name Format CHAR(1..50)
| ||||||||||||||
- |
Street number Format CHAR(1..50)
| ||||||||||||||
+ |
Postcode Format CHAR(2..10) Permitted Symbols
[0-9][A-Z][a-z][
| ||||||||||||||
+ |
City of customer Format CHAR(2..50)
| ||||||||||||||
Parameter (INVALID) - address invalid | |||||||||||||||
+ |
Response code of address check to return whether address has been corrected Format LIST
| ||||||||||||||
+ |
In case of error the PAYONE Platform returns an error code for your internal usage. Format NUMERIC(1..6)
| ||||||||||||||
+ |
In case of error the PAYONE Platform returns an error message for your internal usage. Format CHAR(1..1024)
| ||||||||||||||
- |
The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format CHAR(1..1024)
| ||||||||||||||
Parameter (ERROR) - error | |||||||||||||||
+ |
In case of error the PAYONE Platform returns an error code for your internal usage. Format NUMERIC(1..6)
| ||||||||||||||
+ |
In case of error the PAYONE Platform returns an error message for your internal usage. Format CHAR(1..1024)
| ||||||||||||||
- |
The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format CHAR(1..1024)
| ||||||||||||||
- No labels