Page tree
Skip to end of metadata
Go to start of metadata

Introduction

Checking customer data for any existing adverse criteria.


This request is only available if module “protect” has been ordered.

The customer check is carried out to determine the risk of non-payment of demands against customers. With the help of consumer information (adverse criteria) a score value is determined which you can use to assess the creditworthiness of the customers, get a realistic picture of the risk of non-payment and offer the corresponding types of payment.

For best results please provide “streetname” and “streetnumber” in separate fields. If not possible you can use “street” only.

For “consumerscore” first-/last name is obviously mandatory. Parameter “gender” and “birthday” are optional but recommended for best results.


Valid combinations (Arvato, Boniversum, SCHUFA)

addresschecktype

consumerscoretype

businessrelation

Remarks

Available countries

NO, BA, PE

IH, IA, IB, IF

b2c (optional)

Arvato Infoscore Services

DE

PB

CE

b2c (optional)

Boniversum Services

DE

BS

SFS

b2c (mandatory)

SCHUFA Services

DE

BS

SFS, SFM

b2b (mandatory)

SCHUFA Services

DE

 

Request "consumerscore"

Common Parameter

Required

Format

Comment

aid

+


Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)

addresschecktype

+


PAYONE-Services

BA

Addresscheck Basic

PE

Addresscheck Person

NO

Do not carry out address check

Boniversum-Services – must be combined with consumerscoretype “CE”

PB

Addresscheck Person

SCHUFA-Services – must be combined with consumerscoretype “SFM” / “SFS”

BS

AddressCheck SCHUFA

consumerscoretype

+


Specifies type of consumer score to be performed.

Format

LIST 
ValueComment
Arvato Infoscore Services  – must be combined with addresschecktype “NO”, “BA”, “PE”
IH

Infoscore (hard criteria)

IA

Infoscore (all criteria)

IB

Infoscore (all criteria + bonus score)

IF

Infoscore (all criteria + bonus score) + Informa-Consumer-Score

Boniversum Services – must be combined with addresschecktype “PB”
CE

Boniversum VERITA Score including special addresses (status-codes AS1..AS8)

SCHUFA Services – must be combined with addresschecktype “BS”
SFS

SCHUFA credit worthiness SHORT; can be combined with “b2b” and “b2c”

SFM

SCHUFA credit worthiness MIDDLE; can be combined with “b2b” only

businessrelation

o


Value specifies business relation between merchant and customer

Format

LIST 
valueComment

b2c

Indicates business to private customer

b2b

indicates business to business customer (company)

Request specific:

ConsumerscoretypeComment
SFS, SFM"businessrelation" is mandatory for SCHUFA-checks
other"businessrelation" is recommended be set to "b2c" for other checks

Request "consumerscore"

Parameter

Required

Format

Comment

firstname

o


First name

  • required for b2c-request
  • used for b2b-request of person managed companies (e.g. small business owned by “Max Mustermann”)

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


Surname

  • required for b2c-request
  • used for b2b-request of person managed companies (e.g. small business owned by “Max Mustermann”)

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

o


Company

  • required for b2b-request (e.g. “PAYONE GmbH”)
  • empty for person managed companies

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

+


Street number and name (required if "streetname" and "streetnumber" not submitted)
(required: at least one character)

Street number and name

Format

CHAR(1..50)

streetname

o


Street name (required if "street" not submitted)

Street name

Format

CHAR(1..50)

streetnumber

o


Street number (required if "street" not submitted)

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

+


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

o


Mandatory for SCHUFA Services “b2c”

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

* not in use by now

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 "consumerscore"

Common Parameter

Required

Format

Comment

status

+

Default

VALID / INVALID / ERROR

Parameter (VALID) - address valid

secstatus

o


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

score

+


Indication for all consumerscoretypes

Format

LIST 

valueComments
G

"green", high degree of creditworthiness

Y

"yellow", average degree of creditworthiness

R

"red", low degree of creditworthiness

Uunknown / not available

scorevalue

-


The scorevalue is a more detailed indication of credit worthiness of customers than the score (traffic light).

Please pay attention that the values and the interpretation are provider specific.

Format

NUMERIC(1..4), values and ranges see table below.
consumerscoretypeProviderRangeRemarks
IA, IB, IH, IFArvato InfoscoreScore: 100-990
CEBoniversum VERITAScore: 0-6000
SFS, SFMSCHUFA B2B

Score: 100-600

The higher the value, the lower the degree of creditworthiness; values e.g. “100”, “204”, “202.3”

SFSSCHUFA B2C

Score: 1-9999

The higher the value, the higher the degree of creditworthiness

secscore

-


For consumerscoretype: IA, IB, IH, IF; Negative criteria if registered.

Format

LIST 

Negative criteria; details see code list: Consumer score Arvato Infoscore - secscore

personstatus

+

Default

Person address check result; details see code list: Address check returns (personstatus)

Person address check result; details

Format

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

addressstatus

-

Default

Only available with “CE” and “PB” and only if special address is indicated:

Person address check result; details see code list: Consumer score Boniversum VERITA score addressstatus

provideruserid

-

AN..30

Only with consumerscoretype: SFS, SFM (b2b/b2c): Internal provider reference

identityconfirmed

-

Default

Only with consumerscoretype: SFS (b2c)

Y

Identity has been confirmed

N

Identity has not been confirmed

gender

-

Default

Only with consumerscoretype: SFS (b2c): gender of person

F

Female

M

Male

legalform

-

AN..100

Only with consumerscoretype: SFM (b2b): Legal form <code>;<text>

e.g. “21;Gesellschaft mit beschränkter Haftung”

See list of values: Consumer score SCHUFA legal form

creditlimitvalue

-

AN..10

Only with consumerscoretype: SFM (b2b): Creditlimit value

creditlimitcurrency

-

Default

Only with consumerscoretype: SFM (b2b): Creditlimit currency (ISO-code)

foundingdate

-

AN..10

Only with consumerscoretype: SFM (b2b): Founding date in format yyyy-mm-dd

taxid

-

AN..20

Only with consumerscoretype: SFM (b2b): Tax id of company

company

-


For consumerscoretype: SFM (b2b), Return of company (corrected if applicable)

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)

firstname

+


Return of first name (corrected if applicable)

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

+


Return of surname (corrected if applicable)

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

+


Return of street + street no. (corrected if applicable)

Street number and name

Format

CHAR(1..50)

streetname

-


Return of street name (corrected if applicable)

Street name

Format

CHAR(1..50)

streetnumber

-


Return of street number (corrected if applicable)

Street number

Format

CHAR(1..50)

zip

+


Return of postal code (corrected if applicable)

Postcode

Format

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

city

+


Return of city (corrected if applicable)

City of customer

Format

CHAR(2..50)

Parameter (INVALID) - address invalid

secstatus

+


30           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