PAYONE Documentation Platform | Server API

Introduction

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.

Integration

POST Request - bankaccountcheck

Account Parameters

request required	Fixed Value: bankaccountcheck
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

common Parameters

checktype optional	Format LIST Specifies type of check to be performed, e.g. creditcardcheck or bankaccountcheck
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.

Check of international bank account Parameters

bankcountry required	Format LIST 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
iban optional	Format CHAR(8 or 11) Only capital letters and digits, no spaces Permitted Symbols [0-9][A-Z] Bank Identifier Code to be used for payment or to be checked
bic optional	Format CHAR(8 or 11) Only capital letters and digits, no spaces Permitted Symbols [0-9][A-Z] BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required.

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

bankcountry required	Format LIST 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
bankaccount optional	Format NUMERIC(1..10) 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.
bankcode optional	Format NUMERIC(8) 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.

Response Parameters

status

Permitted Values
VALID
INVALID
ERROR
BLOCKED

Response Parameter (VALID)

iban	Format CHAR(8 or 11) Only capital letters and digits, no spaces Permitted Symbols [0-9][A-Z] Bank Identifier Code to be used for payment or to be checked.
bic	Format CHAR(8 or 11) Only capital letters and digits, no spaces Permitted Symbols [0-9][A-Z] BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required.
bankaccount	Format NUMERIC(1..10) 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.
bankcode	Format NUMERIC(8) 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.
bankcountry	Format LIST 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
bankbranchcode	Format N..5 Branch code
bankcheckdigit	Format AN..2 Check digit

Response Parameter (INVALID) - account details invalid

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

Response Parameter (Error) - request faulty

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

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

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
        
aid=52078
api_version=3.8
bankaccount=0211691049
bankcode=30020900
bankcountry=DE
channel=serverapi
checktype=0
encoding=UTF-8
hash=b6a1080ea8a9526bde298f9930ebe935eefc889e83f7e82bc40e74e126f795c2289bf5464d8f8a0351971721b54d3db6
mid=14648
mode=test
portalid=2037267
request=bankaccountcheck
responsetype=JSON

RESPONSE 

iban=DE26300209000211691049
bic=TESTTEST
bankaccount=0211691049
bankcode=30020900
bankcountry=DE
status=VALID