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.
POST Request - addresscheck
| request
required
|
Fixed Value: addresscheck
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
| channel required
|
Fixed Value: clientapi
|
| channelDetail required
|
Permitted Value: payoneHosted
|
| addresschecktype required
|
Format LIST
Primary account number of credit card |
|||||||||||||||
| firstname optional
|
Format CHAR(1..50)
First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
|||||||||||||||
| lastname
optional
|
Format CHAR(2..50)
Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
|||||||||||||||
| company optional
|
Format CHAR(2..50)
Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
|||||||||||||||
| street optional
|
Format CHAR(1..50)
Street number and name (required: at least one character) |
|||||||||||||||
| streetname optional
|
Format CHAR(1..50)
Street name |
|||||||||||||||
| streetnumber optional
|
Format CHAR(1..50)
Street number |
|||||||||||||||
| zip optional
|
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]
Postcode |
|||||||||||||||
| city required
|
Format CHAR(2..50)
City of customer |
|||||||||||||||
| country required
|
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples
DE GB US Specifies country of address for the customer Check “BB”, “PB”: only “DE” supported
|
|||||||||||||||
| telephonenumber optional
|
Format CHAR(1..30)
Phone number of customer |
|||||||||||||||
| birthday optional
|
Format DATE(8), YYYYMMDD
Samples
20190101 19991231 Date of birth of customer |
|||||||||||||||
| language optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes
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. |
|||||||||||||||
| gender optional
|
Format LIST
Permitted values: f / m / d
Gender of customer (female / male / diverse* ) * currently not in use |
|
Permitted Values
VALID
INVALID
ERROR |
| secstatus |
Format LIST
Response code of address check to return whether address has been corrected |
||||||||||||
| personstatus |
Format LIST
Person address check result; details see code list (“Parameters for address check person returns”) |
||||||||||||
| firstname |
Format CHAR(1..50)
First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||||||||
| lastname |
Format CHAR(2..50)
Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||||||||
| company |
Format CHAR(2..50)
Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||||||||
| street |
Format CHAR(1..50)
Street number and name (required: at least one character) |
||||||||||||
| streetname |
Format CHAR(1..50)
Street name |
||||||||||||
| streetnumber |
Format CHAR(1..50)
Street number |
||||||||||||
| zip |
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]
Postcode |
||||||||||||
| city |
Format CHAR(2..50)
City of customer |
| secstatus |
Format LIST
Response code of address check to return whether address has been corrected |
||||||||||||
| errorcode |
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
||||||||||||
| errormessage |
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
||||||||||||
| customermessage |
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") |
| errorcode |
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
| errormessage |
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
| customermessage |
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") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
RESPONSE