Skip to end of metadata
Go to start of metadata

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

FormatComment

aid

+


Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)

addresschecktype

+


Specifies type of address check to be performed

Format

LIST
ValueGroupComment
BAPAYONE Services

Addresscheck Basic, i.e. address is checked whether the address itself is valid and existing

PEPAYONE ServicesAddresscheck Person, i.e. address is checked whether the address itself is valid and existing and whether the given person is recorded at this address
BBBoniversum ServicesAddresscheck Basic, i.e. address is checked whether the address itself is valid and existing
PBBoniversum ServicesAddresscheck Person, i.e. address is checked whether the address itself is valid and existing and whether the given person is recorded at this address

firstname

o


First name of customer; optional if company is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(1..50)

lastname

o


Last name of customer; optional if company is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(2..50)

company

-


Company name of customer; The company name is optional if lastname is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(2..50)

street

o


Street number and name (required: at least one character)

Format

CHAR(1..50)

streetname

o


Street name

Format

CHAR(1..50)

streetnumber

o


Street number

Format

CHAR(1..50)

zip

+


Postcode

Format

CHAR(2..10)
Permitted Symbols
[0-9][A-Z][a-z][_.-/ ]

city

+


City of customer

Format

CHAR(2..50)

country

+


Check “BB”, “PB”: only “DE” supported

Specifies country of address for the customer

Format

LIST

Permitted values

ISO 3166 2-letter-codes

Samples

DE
GB
US

Some countries require additional information in parameter "state"

birthday

-


Date of birth of customer


Format

DATE(8), YYYYMMDD

Samples

20190101
19991231

telephonenumber

-


Phone number of customer

Format

CHAR(1..30)

gender

-


Gender of customer (female / male / diverse* )

Format

LIST

Permitted values

f    
m
d

* currently not in use

language

-


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

secstatus

+


Response code of address check to return whether address has been corrected

Format

LIST
ValueStatusComment
10VALID

address correct

20VALID

address could be corrected / has changed

30INVALID

address could not be corrected

personstatus

+

Default

Person address check result; details see code list (“Parameters for address check person returns”)

Person address check result; details

Format

LIST
ValueComment
<list>List of codes: AddressCheck-Returns (personstatus)

firstname

-


First name of customer; optional if company is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(1..50)

lastname

-


Last name of customer; optional if company is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(2..50)

street

+


Street number and name (required: at least one character)

Format

CHAR(1..50)

streetname

-


Street name

Format

CHAR(1..50)

streetnumber

-


Street number

Format

CHAR(1..50)

zip

+


Postcode

Format

CHAR(2..10)
Permitted Symbols
[0-9][A-Z][a-z][_.-/ ]

city

+


City of customer

Format

CHAR(2..50)

Parameter (INVALID) - address invalid

secstatus

+


Response code of address check to return whether address has been corrected

Format

LIST
ValueStatusComment
10VALID

address correct

20VALID

address could be corrected / has changed

30INVALID

address could not be corrected

errorcode

+


In case of error the PAYONE Platform returns an error code for your internal usage.

Format

NUMERIC(1..6)

errormessage

+


In case of error the PAYONE Platform returns an error message for your internal usage.

Format

CHAR(1..1024)

customermessage

-


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

errorcode

+


In case of error the PAYONE Platform returns an error code for your internal usage.

Format

NUMERIC(1..6)

errormessage

+


In case of error the PAYONE Platform returns an error message for your internal usage.

Format

CHAR(1..1024)

customermessage

-


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