TECHNICAL REFERENCE 1.34 PAYONE Platform Channel Client API Version: Version: Edition: 2016-12-15 Table of Contents Table of Contents.............................................................................................................. 2 Preface ............................................................................................................................. 5 History of changes ............................................................................................................ 6 1 General ...................................................................................................................... 13 1.1 Accounts ...................................................................................................................................... 15 1.2 Payment portals .......................................................................................................................... 16 1.3 Debtor accounts .......................................................................................................................... 17 1.4 Invoicing ...................................................................................................................................... 18 1.5 Dunning processes and encashment .......................................................................................... 19 1.6 Administration of subscriptions .................................................................................................. 20 2 Payment portals ......................................................................................................... 21 2.1 Payment portal version "Access" ................................................................................................ 21 2.1.1 Creating a payment portal of the version "Access" ............................................................. 21 2.1.2 Adding an offer to a payment portal ................................................................................... 22 2.1.3 Extended options of the payment portal............................................................................. 23 2.2 Payment portal version "Shop" ................................................................................................... 24 2.2.1 Creating a payment portal of the version "Shop" ............................................................... 24 3 Interface definitions ................................................................................................... 25 3.1 General ........................................................................................................................................ 25 3.1.1 Data transfer ........................................................................................................................ 25 3.1.2 Standard parameter ............................................................................................................. 26 3.1.3 Special remark ..................................................................................................................... 27 3.1.4 Calculation of the HASH value ............................................................................................. 28 3.1.5 PAYONE hosted-iFrame mode (credit card data, PCI DSS) .................................................. 31 3.1.5.1 .... Brief description ........................................................................................................ 32 3.1.5.2 .... Table of config-attributes .......................................................................................... 33 3.1.5.3 .... Table of request-attributes ....................................................................................... 35 3.1.5.4 .... Simple example (cardtype selected in PAYONE iFrame) ........................................... 36 3.1.5.5 .... Simple example (cardtype set by shop-system) ........................................................ 39 3.1.5.6 .... Additional tips ........................................................................................................... 42 3.1.5.6.1 Changing display text for month drop down 42 3.1.5.6.2 Changing display text for error messages 42 Edition: 2016-12-15 Technical Reference PAYONE Platform Client API Version 1.34 2 3.1.5.6.3 Specifying placeholder text for input fields 42 3.1.6 AJAX mode ........................................................................................................................... 43 3.1.7 Redirect mode...................................................................................................................... 45 3.2 Payment ...................................................................................................................................... 47 3.2.1 Initiating payment reservation (preauthorization) .............................................................. 47 3.2.2 Initiating payment process (authorization) ......................................................................... 56 3.2.3 Creating a contract (createaccess) ...................................................................................... 65 3.2.4 Initiating payment process on a virtual account (vauthorization) ...................................... 72 3.3 Administration ............................................................................................................................ 77 3.3.1 Create a mandate (managemandate) .................................................................................. 77 3.4 Verification / Scoring ................................................................................................................... 79 3.4.1 Verifying credit cards (creditcardcheck) .............................................................................. 79 3.4.2 Account verification (bankaccountcheck) ........................................................................... 81 3.4.3 Address verification (addresscheck) .................................................................................... 83 3.4.4 Verification of creditworthiness (consumerscore) .............................................................. 85 4 Responses .................................................................................................................. 89 4.1 Parameter for SessionStatus query............................................................................................. 89 4.2 Parameter for the TransactionStatus query ............................................................................... 92 4.2.1 List of events (txaction) ........................................................................................................ 98 4.2.2 List of status (transaction_status)...................................................................................... 100 4.2.3 Explanation of price, balance, receivable .......................................................................... 101 4.2.4 Sample: authorization, CC .................................................................................................. 101 4.2.5 Sample: preauthorization/capture, CC .............................................................................. 102 4.2.6 Sample: authorization, ELV with cancelation .................................................................... 103 4.2.7 Sample: preauthorization/capture, REC with credit note ................................................. 104 4.2.8 Sample: preauthorization, WLT (with “pending”) ............................................................. 105 5 Codes ........................................................................................................................ 106 5.1 Reasons for return debit notes ................................................................................................. 106 5.2 Bank groups ............................................................................................................................... 107 5.3 Parameters for AVS returns ...................................................................................................... 108 5.4 BankAccountCheck (Available countries) ................................................................................. 109 5.5 Parameters for address check person returns .......................................................................... 110 5.5.1 AddressCheck PAYONE Services - personstatus ................................................................ 110 5.5.2 AddressCheck Boniversum Services - personstatus .......................................................... 111 5.6 Parameters for Consumerscore returns ................................................................................... 112 Edition: 2016-12-15 Technical Reference PAYONE Platform Client API Version 1.34 3 5.6.1 Consumerscore arvato Infoscore - secscore ...................................................................... 112 5.6.2 Decision matrix Arvato Infoscore Boni-Score / Informa-Score .......................................... 116 5.6.3 Decision matrix Boniversum VERITA score ........................................................................ 118 5.6.4 Consumerscore Boniversum VERITA score - scorevalue ................................................... 120 5.6.5 Consumerscore Boniversum VERITA score - addressstatus .............................................. 121 5.7 Error messages .........................................................................................................................