Table Of Contents
  INTRODUCTION  OVERVIEW  AVAILABILITY BY COUNTRY/CURRENCY  FUNCTIONAL LIMITATIONS AND ADDITIONAL INFORMATION  SHOP-PLUGINS  TEST DATA  INTEGRATIONS

Introduction

PAYONE Secure Invoice offers merchants in German-speaking countries the opportunity to integrate the "Buy Now, Pay Later" payment method invoice as payment method in their online store.

In doing so, our Partner HIT assumes the full fraud and default risk and supports merchants throughout the entire value chain from integration assistance to collection handover. 

Overview

Availability by Country/Currency

Payment Type Countries Currency B2C B2B

Invoice

Germany
Austria

Switzerland

EUR

yes

yes

Functional Limitations and Additional Information

Right now there are certain limitations for PAYONE Secure Invoice that need to be taken into account during the implementation. All information that is relevant for the merchant is summarized here.

  • Currently no support for increasing receivables with a debit request.
  • Request preauthorization is only valid for 28 days.
  • Processing only possible for EUR currency for Switzerland.
  • Currently no support for refunds after start of encashment.
  • To set up your merchant account for secure invoice, we need to configure a new dedicated payment portal for this payment method. Please make sure, that you send the dedicated portalid and key within your requests for clearingtype REC with subtype POV.
  • Shipping address and invoice address must be same for a payment guarantee to be granted.

Shop-Plugins

In some shop systems, there is no dedicated switch for B2B/B2C transactions. To solve this, a transaction is flagged as B2B when the parameter company is filled. There is no further check, if the company name is correct.

Test Data

Payone has specific testdata for the prepayment tests:

Usecase lastname Behavior
Full payment Payer Simulation for a full payment of the requested amount
Underpayment Underpayer An incoming payment for 95% of the requested amount is simulated.
Overpayment Overpayer An incoming payment for 105% of the requested amount is simulated.
Split Payment Splitpayer An incoming payment for 95% of the requested amount is simulated first. Then shortly after a second incoming payment is simulated completing the requested amount.

Integrations

POST Request - Pre-/ Authorization

During the preauthorization a risk check for the customer is performed. Depending on the result the customer qualifies or disqualifies from using this payment method. When the risk of payment default is deemed too high the transaction can’t be insured and the customer is denied, yielding an error message and the status “ERROR”.
Generally, the more customer data you send, the better the risk check can decide to give an insurance or not. Nonetheless, there following table contains flags, if a parameter is optional or not.

If the preauthorization is successful the response will contain the status “APPROVED”.

Using the Preauthorization request does NOT finalize the claim. In order to start the dunning process the transactions need to be captured first.

Please bear in mind, that a preauthorization is valid for 28 days. You need to make sure, that you capture this preauthorization in this period. Otherwise, if you know that you won’t capture the amount, please send a cancel (capture with amount=0), to free the reserved guarantee.

The authorization request simply combines both the prauthorization and the capture steps.

Account Parameters
request
required
Fixed Value: preauthorization / authorization
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
clearingtype
required
Fixed Value: rec
clearingsubtype
required
Fixed Value: POV

PAYONE Secured Direct Debit
mode
required
Fixed Value: test/live

can be either test environment (test) or live environment (live)
reference
optional
Format CHAR(2..255)

a unique ID that will be displayed in your shop backend and for the customer
amount
required
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99

Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro.

The amount must be less than or equal to the amount of the corresponding booking.
currency
required
Format LIST

Permitted values ISO 4217 (currencies) 3-letter-codes

 

Samples EUR, USD, GBP
param
optional
Format CHAR(1..255)

Individual parameter (per payment process)
narrative_text
optional
Format CHAR(1..81)

Dynamic text element on account statements.

(3 lines with 27 characters each) and credit card statements.
customer_is_present
optional
Format LIST
Permitted Values yes / no

Indicates whether customer is “present” and can enter their data in the shop (=yes). Or customer is not present and can not enter any data (=no).
PERSONAL DATA Parameters
customerid
optional
Format CHAR(1..20)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/]

Merchant's customer ID, defined by you / merchant to refer to the customer record.

"customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically.
userid
optional
Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE
businessrelation
optional
Format LIST
value Comment
b2c

Indicates business to private customer
b2b

indicates business to business customer (company)

currently not available for PDD

Value specifies business relation between merchant and customer
salutation
optional
Format CHAR(1..10)

The customer's salutation
title
optional
Format CHAR(1..20)
Samples Dr
        Prof.
        Dr.-Ing.

Title of the customer
firstname
optional
Format CHAR(1..50)

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

"company" or "lastname" or "firstname" plus "lastname"
lastname
required
Format CHAR(2..50)

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

"company" or "lastname" or "firstname" plus "lastname"
company
optional
Format CHAR(2..50)

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

"company" or "lastname" or "firstname" plus "lastname"
street
optional
Format CHAR(1..50)

Street number and name (required: at least one character)
addressaddition
optional
Format CHAR(1..50)

Samples 7th floor
c/o Maier

Specifies an additional address line for the invoice address of the customer.
zip
optional
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]

Postcode
city
optional
Format CHAR(2..50)

City of customer
country
required
Fixed Value DE
email
optional
Format CHAR(5..254)

Mandatory if "add_paydata[shopping_cart_type]=DIGITAL"

Permitted Symbols RFC 5322

Special Remark email validation:

Max. length for email is 254 characters. Validation is set up in the following way:

Username = Max. 63 characters

Domain Name = Max. 63 characters
Domain Suffixes = Max. 4 suffixes with max. 124 characters
Example: username[63]@domain_name[63].suffix[60].suffix[60].suffix[4]

"@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters.

email-address of customer
telephonenumber
optional
Format CHAR(1..30)

Phone number of customer
birthday
optional
Format DATE(8), YYYYMMDD

Samples 20190101 /  19991231

Date of birth of customer
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.
vatid
optional
Format CHAR(1..50)

VAT identification number. Used for b2b transactions to indicate VAT number of customer.
gender
optional
Format LIST

Permitted values f/ m/  d

Gender of customer (female / male / diverse* )

* currently not in use
personalid
optional
Format CHAR(1..32)

Permitted Symbols [0-9][A-Z][a-z][+-./()]

Person specific numbers or characters, e.g. number of passport / ID card
ip
optional
Format CHAR(1..39)

Customer's IP-V4-address (123.123.123.123) or IP-V6-address
Delivery data Parameters
shipping_firstname
required
Format CHAR(1..50)

First name of delivery address
shipping_lastname
required
Format CHAR(1..50)

Surname of delivery address
shipping_company
optional
Format CHAR(2..50)

Company name of delivery address
shipping_street
optional
Format CHAR(2..50)

Street number and name of delivery address
shipping_zip
required
Format CHAR(2..50)

Postcode of delivery address
shipping_addressaddition
optional
Format CHAR(1..50)

Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier".
shipping_country
optional
Format LIST

Permitted values ISO 3166 2-letter-codes

 

Samples DE/ GB/ US
 

Specifies country of address for the customer.

Some countries require additional information in parameter "state"
shipping_state
required (in CN)
Format LIST

Permitted values ISO 3166-2 States (regions)  2-letter-codes

Samples US Samples CA
AK AB
AL BC
Article Parameters
it[n]
required
it[n] Comments
goods Goods
shipment Shipping Charges
handling Handling fee
voucher Voucher / discount

required for physical goods in order to ensure PayPal seller protection
id[n]
required
Format CHAR(1..32)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Symbols [0-9][a-z][A-Z], .,-,_,/

required for physical goods in order to ensure PayPal seller protection

International Article Number (EAN bzw. GTIN)

Product number, SKU, etc. of this item
pr[n]
required
Format NUMERIC(10) max. 19 999 999 99
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted

required for physical goods in order to ensure PayPal seller protection

Unit gross price of the item in smallest unit! e.g. cent
no[n]
required
Format NUMERIC(6)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted

required for physical goods in order to ensure PayPal seller protection

Quantity of this item
de[n]
required
Format CHAR(1..255)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted

required for physical goods in order to ensure PayPal seller protection

Description of this item. Will be printed on documents to customer.
va[n]
optional
Format NUMERIC(4)

VAT rate (% or bp)

Array elements [n] starting with [1]; serially numbered; max [400]
Response Parameters
status
required
Permitted Values
APPROVED
ERROR
ReSponse Parameter (approvedt)
txid
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE
ReSponse Parameter (Error)
Format NUMERIC(1..6)

In case of error the PAYONE Platform returns an error code for your internal usage.
Format CHAR(1..1024)

In case of error the PAYONE Platform returns an error message for your internal usage.
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

request=preauthorization
mid=54321
aid=12345
portalid=12345123
key=abcdefghijklmn123456789
clearingtype=rec
clearingsubtype=POV
mode=test
reference=jv-1668434776
amount=20000
currency=EUR
param=individualParameter
narrative_text=messageoralternativetext
customer_is_present=yes
businessrelation=b2c
firstname=Max
lastname=Mustermann
street=Musterweg 1
city=Musterstadt
zip=12345
country=DE
telephonenumber=491731234567
email=max@mustermann.de
birthday=19820324
ip=123.123.123.123
it[1]=goods
it[2]=shipment
id[1]=1001001
id[2]=1001002
de[1]=Testartikel 1
de[2]=Transport
no[1]=1
no[2]=1
pr[1]=1000
pr[2]=100
va[1]=19
va[2]=19
successurl=http://www.your-success.url
errorurl=http://www.your-error.url
backurl=http://www.your-back.url
RESPONSE

status=APPROVED
txid=753359579
userid=483104612
POST Request - Capture

If the transaction was initialized with a preauthorization request, you have to capture the transaction after fulfillment. The dunning process will not be started before capturing the transaction.

Account Parameters
request
required
Fixed Value: capture
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
txid
required
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
required
Format fixed: Test/live
Environment in which the transaction is captured
capturemode
optional
Format LIST
Value Comment
completed

Set with last capture; i.e.: Delivery completed.
No further capture is allowed.
notcompleted

Set with partial deliveries (last delivery with "completed")
Another capture is expected to complete the transaction.

Specifies whether this capture is the last one or whether there will be another one in future.
sequencenumber
optional
Format NUMERIC(1..3)

Permitted values 0..127

Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2

Required for multi partial capture (starting with the 2nd capture)
amount
required
Format NUMERIC(1..10)

Permitted values max. +/- 19 999 999 99

Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona.

The amount must be less than or equal to the amount of the corresponding booking.
currency
required
Fixed Value EUR
optional
Format LIST
Value Comment
yes

Settlement of outstanding balances has been carried out.
no

Settlement of outstanding balances has not been carried out.

Provides information about whether a settlement of balances has been carried out.
Response Parameters
Permitted Values
APPROVED
PENDING
ERROR
Response Parameter (approved)
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
Format LIST 
Value Comment
yes

Settlement of outstanding balances has been carried out.
no

Settlement of outstanding balances has not been carried out.

Provides information about whether a settlement of balances has been carried out.
Response parameters (pending)
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE
Request Body schema: application/json
Format NUMERIC(1..6)

In case of error the PAYONE Platform returns an error code for your internal usage.
Format CHAR(1..1024)

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

 
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload

request=capture
mid=54321
aid=12345
portalid=12345123
key=abcdefghijklmn123456789
txid=753359579
mode=test
capturemode=completed
sequencenumber=1
amount=20000
currency=EUR
settleaccount=auto
it[1]=goods
it[2]=shipment
id[1]=1001001
id[2]=1001002
de[1]=Testartikel 1
de[2]=Transport
no[1]=1
no[2]=1
pr[1]=10000
pr[2]=10000
va[1]=19
va[2]=19

RESPONSE

status=APPROVED
txid=753359579
settleaccount=yes
POST Request - Debit
Account Parameters
request
required
Fixed Value: debit
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
txid
required
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
mode
required
Format fixed: Test/live

Environment in which the transaction is refunded
sequencenumber
required
Format NUMERIC(1..3)

Permitted values 0..127

Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2

Required for multi partial capture (starting with the 2nd capture)
amount
required
Format NUMERIC(1..10)

Permitted values max. +/- 19 999 999 99

Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona.

The amount must be less than or equal to the amount of the corresponding booking.
currency
required
Fixed Value EUR
narrative_text
optional
Format CHAR(1..81)

Dynamic text element on account statements

(3 lines with 27 characters each) and credit card statements.
clearingtype
optional
Fixed Value wlt
use_customerdata
optional
Format LIST
Value Comment
yes

Uses current account details from debtor's master data (default)
no

Uses the last known account details in the payment process

Use account details from debtor's master data
transaction_param
optional
Format CHAR(1..50)
Permitted Symbols [0-9][A-Z][a-z][.-_/]

Optional parameter for merchant information (per payment request)
Article Parameters
it[n]
required
it[n] Comments
goods Goods
shipment Shipping Charges
handling Handling fee
voucher Voucher / discount

required for physical goods in order to ensure PayPal seller protection
id[n]
required
Format CHAR(1..32)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Symbols [0-9][a-z][A-Z], .,-,_,/

required for physical goods in order to ensure PayPal seller protection

International Article Number (EAN bzw. GTIN)

Product number, SKU, etc. of this item
pr[n]
required
Format NUMERIC(10) max. 19 999 999 99
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted

required for physical goods in order to ensure PayPal seller protection

Unit gross price of the item in smallest unit! e.g. cent
no[n]
required
Format NUMERIC(6)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted

required for physical goods in order to ensure PayPal seller protection

Quantity of this item
de[n]
required
Format CHAR(1..255)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted

required for physical goods in order to ensure PayPal seller protection

Description of this item. Will be printed on documents to customer.
va[n]
optional
Format NUMERIC(4)

VAT rate (% or bp)

Array elements [n] starting with [1]; serially numbered; max [400]
Response Parameters
status
Permitted Values
APPROVED
ERROR
Response Parameter (approved)
txid
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
settleaccount
Format LIST 
Value Comment
yes

Settlement of outstanding balances has been carried out.
no

Settlement of outstanding balances has not been carried out.

Provides information about whether a settlement of balances has been carried out.
Response Parameter (error)
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

mid=23456
aid=12345
amount=-20000
currency=EUR
key=abcdefghijklmn123456789
mode=test
portalid=12345123
request=refund
sequencenumber=2
txid=753359579
RESPONSE

status=APPROVED
txid=753359579            

Sequence Diagrams

Order-Delivery