- Created by PAYONE Admin, last modified by BS PAYONE on 2019-08-13
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 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+ | Format | |||||||||||||||||
+ | Specifies type of address check to be performed Format Addresscheck Basic, i.e. address is checked whether the address itself is valid and existing | |||||||||||||||||
o | First name of customer; optional if company is used, i.e.: you may use Format | |||||||||||||||||
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 | |||||||||||||||||
o | Format | |||||||||||||||||
o | Format | |||||||||||||||||
o | Format | |||||||||||||||||
+ | Format | |||||||||||||||||
+ | Format | |||||||||||||||||
+ | ||||||||||||||||||
- | Date of birth of customer Format DATE(8), YYYYMMDD Samples 20190101 19991231 | |||||||||||||||||
- | Format | |||||||||||||||||
- | Format Permitted values * not in use by now | |||||||||||||||||
- | 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 address correct address could be corrected / has changed address could not be corrected | ||||||||||||||
+ | Default | Person address check result; details see code list (“Parameters for address check person returns”) Format | |||||||||||||
- | First name of customer; optional if company is used, i.e.: you may use Format | ||||||||||||||
- | Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50) | ||||||||||||||
+ | Format | ||||||||||||||
- | Format | ||||||||||||||
- | Format | ||||||||||||||
+ | Format | ||||||||||||||
+ | Format | ||||||||||||||
Parameter (INVALID) - address invalid | |||||||||||||||
+ | Response code of address check to return whether address has been corrected Format address correct address could be corrected / has changed address could not be corrected | ||||||||||||||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | ||||||||||||||
+ | In case of error the PAYONE Platform returns an error message for your internal usage. Format | ||||||||||||||
- | 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 | ||||||||||||||
Parameter (ERROR) - error | |||||||||||||||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | ||||||||||||||
+ | In case of error the PAYONE Platform returns an error message for your internal usage. Format | ||||||||||||||
- | 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 | ||||||||||||||
- No labels