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

The BankAccountCheck checks the plausibility of German account details according to the current check digit algorithms and carries out a POS blacklist inquiry if required.

Request "bankaccountcheck"

Common Parameter

Required

Format

Comment

aid

+


Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)

checktype

-


Specifies type of check to be performed, e.g. creditcardcheck or bankaccountcheck

Format

LIST 
RequestValueComment
bankaccountcheck0
  • regular check (default)
  • IBAN is checked for correct syntax (mode live only)
  • IBAN is splitted into BBAN (mode live only)
bankaccountcheck1
  • check against POS blacklist (only DE)
bankaccountcheck2
  • check against NCA list (non-consumer account)
creditcardcheck
  • without "checktype" given the regular check is performed (LUHN-check)

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

Check of international bank account

bankcountry

o


Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE

DE: Mandatory with bankcode, bankaccount, optional with IBAN

For other countries than DE please use IBAN or IBAN/BIC

Format

LIST 

iban

+


IBAN to be used for payment or to be checked

Format

CHAR(10..34)
Permitted Symbols
[0-9][A-Z]

bic

+


Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11)
Permitted Symbols
[0-9][A-Z]

Check of national bank account (only DE – with IBAN-calculation)

bankcountry

+


Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE

DE: Mandatory with bankcode, bankaccount, optional with IBAN

For other countries than DE please use IBAN or IBAN/BIC

Format

LIST 

bankaccount

+


Account number (BBAN)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(1..10)

bankcode

+


Sort code (BBAN) (only in DE)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(8)


Response "bankaccountcheck"

Common Parameter

Required

Format

Comment

status

+

Default

VALID / INVALID / ERROR / BLOCKED

Parameter (VALID) - account details valid

bankcountry

o


Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE

DE: Mandatory with bankcode, bankaccount, optional with IBAN

For other countries than DE please use IBAN or IBAN/BIC

Format

LIST 

bankcode

o


Sort code (BBAN) (only in DE)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(8)

bankaccount

o


Account number (BBAN)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(1..10)

bankbranchcode

o

N..5

Branch code

bankcheckdigit

o

AN..2

Check digit

iban

o


IBAN to be used for payment or to be checked

Format

CHAR(10..34)
Permitted Symbols
[0-9][A-Z]

bic

o


Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11)
Permitted Symbols
[0-9][A-Z]

Parameter (BLOCKED) - account details found on blacklist or NCA list  (checktype = 1 or 2 only)

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 (INVALID) - account details invalid

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) - request faulty

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