Introduction

For booking a request on a billing account in the billing module, the PAYONE Platform can automatically initiate a settlement to settle the balance of the account.

The number of articles per settlement period is limited top 400 articles. Please shorten the settlement period if necessary.

This option is available in the "Shop" and "Access" option. 

Integration

POST Request - Vauthorization
Account Parameters
request
required
Fixed Value: preauthorisation
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

---end

common Parameters
clearingtype
required
Fixed Value wtl/fnc/sb/cc/vor/rec
clearingsubtype
optional
Fixed Value POV

Only valid with “clearingtype=rec”. Used for PAYONE Secure Invoice.

mode
required
Fixed Value test/live

can be either test environment (test) or live environment (live)

vreference
required
Format CHAR(1..20)
Permitted Symbols [0-9][a-z][A-Z], .,-,_,/

Merchant's transaction reference number

vaccountname
required
Format CHAR(1..20)
Permitted Symbols
[0-9, a-z, A-Z, .,-,_,/]

ID/name of the merchant's billing account

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
settle_period_length
required
Format NUMERIC(1..3)
 

Length of the accounting period

settle_period_unit
required
Format LIST
Value Comment
Y Value “length” is in years
M Value “length” is in months
D Value “length” is in days

Time unit of the accounting period

settletime
required
Format Unixtimestamp
 

Date for the next invoicing Unixtimestamp in the future.

param
optional
Format CHAR(1..255)

Individual parameter (per payment process)

---end

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

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
optional
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
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".
state
optional
Format LIST
Permitted values ISO 3166-2 States (regions)
2-letter-codes
Samples US Samples CA
AK BC
AB AR
AL

Specifies state / region of country for the customer.
"state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN and must not be used for all other countries.

email
optional
Format CHAR(5..254)
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.

ip
optional
Format CHAR(1..39)

Customer's IP-V4-address (123.123.123.123) or IP-V6-address

---end

Delivery data Parameters
shipping_firstname
optional
Format CHAR(1..50)

First name of delivery address

shipping_lastname
optional
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
optional
Format CHAR(2..50)

Postcode of delivery address

shipping_city
optional
Format CHAR(2..50)

City 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

---end

URL PARAMETERS
successurl
optional
Format CHAR(2..255)

Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

URL for "payment successful"

errorurl
optional
Format CHAR(2..255)

Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

URL for "faulty payment"

backurl
optional
Format CHAR(2..255)

Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

URL for "Back" or "Cancel"

---end

Article Parameters
invoice_deliverymode
optional
Format LIST
Value Comment
M Postal Mail
P PDF (via email)
N no delivery

Parameter defines how documents like invoice, credit notes and reminders should be sent to the customer.

it[n]
optional
Format List
it[n] Comments
goods Goods
shipment Shipping Charges
handling Handling fee
voucher Voucher / discount

---end

id[n]
optional
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]
optional
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]
optional
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]
optional
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]

sd[n]
optional
Format DATE(8), YYYYMMDD
Delivery date (YYYYMMDD)
ed[n]
optional
Format DATE(8), YYYYMMDD
Array elements [n] starting with [1]; serially numbered; max [400]

Delivery period end date (YYYYMMDD)

---end

Debit PARAMETERS
bankcountry
optional
Format LIST
Permitted Values DE; DK; EE; ES; FI; IT; MT; NL; NO; PL; SE

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.

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.

bankaccountholder
optional
Format CHAR(1..50)

Account holder

mandate_identification
optional
Format CHAR(1..35)
Permitted Symbols [A-Z,a-z,0-9,+,-,.,(,)]

A SEPA mandate can be created if a payment is initiated (amount > 0). Can be used to enforce a merchant specific mandate identification. The mandate_identification has to be unique.

If the mandate_identification is not set PAYONE will create an unique mandate identification (pattern: PO-nnnnnnnnnn).

PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification

---end

Credit Card Parameters
cardpan
optional
Format NUMERIC(13..19)
If your system handles "cardpan" directly you can not be PCI DSS SAQ A compliant.
For simple PCI DSS SAQ A compliance please use PAYONE hosted iFrames together with pseudocardpan.

Primary account number of credit card

cardtype
optional
Format LIST
Card type of credit card

Primary account number of credit card

value Comment BIN-Range for automatic card type detection
V Visa 4
M MasterCard 51-55,2221-2720
A American Express 34, 37
D Diners / Discover

300-305,3095,36,38,39

601, 64, 65

J JCB 3528-3589
O Maestro International 50, 56-58,602, 61, 620, 627, 63, 67
P China Union Pay 62212600-62299800,624-626, 6282-6288
U UATP / Airplus 1220, 1920 -> coming soon; not available yet
G girocard 68*

*girocard is currently only viable for e-commerce-payments via Apple Pay.

cardexpiredate
optional
Format NUMERIC(4), YYMM

Credit card expiry date YYMM

cardcvc2
optional
Format NUMERIC(3..4)
For SAQ A compliance: PAYONE Frontend hosted iFrame must be used. This parameter must not be used.
cardissuenumber
optional
Format NUMERIC(1..2)

Card issue number (only Maestro UK cards)

cardholder
optional
Format CHAR(1..50)

Cardholder of credit card.

pseudocardpan
optional
Format NUMERIC(16..19)

Pseudo primary account number for a credit card.

---end

3-D Secure Parameters
xid
optional
Format CHAR(1..60)
  • - either "xid" (from previous 3dscheck)
  • - or "successurl", "errorurl", "backurl" must be given.

3-D Secure transaction ID (if the request "3dscheck" was used previous transactions), i.e.:

  • - value for "xid" is returned by request 3dscheck (optional request)
  • - and then has to be used for request authorization, preauthorization or createaccess in request data
cavv
optional
Format CHAR(1..40)

3-D Secure authentication value

eci
optional
Format CHAR(1..2)

3-D Secure e-commerce indicator

successurl
optional
Format CHAR(2..255)

Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

- either "xid" (from previous 3dscheck)
- or "successurl", "errorurl", "backurl" must be given
- or default "successurl" and "backurl" for a portal are configured within PMI.
 

URL for "payment successful"

errorurl
optional
Format CHAR(2..255)

Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

- either "xid" (from previous 3dscheck)
- or "successurl", "errorurl", "backurl" must be given.
 

URL for "faulty payment"

backurl
optional
Format CHAR(2..255)

Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

- either "xid" (from previous 3dscheck)
- or "successurl", "errorurl", "backurl" must be given
- or default "successurl" and "backurl" for a portal are configured within PMI.
 

URL for "Back" or "Cancel"

---end

Financing Parameters
financingtype
optional
Format LIST

Used with "clearingtype=fnc" to identify Financing type

Value Comment
RPV Ratepay Open Invoice
RPS Ratepay Installments
RPP Ratepay Prepayment
RPD Ratepay Direct Debit
PYV Unzer Invoice
PYS Unzer Installment
PYM Unzer Monthly
PYD Unzer Direct Debit
PPI PayPal Installment
KLV Klarna Checkout Invoice
KLS Klarna Checkout Installment
KIS Klarna Payments "Slice it" (Installments)
KIV Klarna Payments "Pay now" (Invoice)
KDD Klarna Payments "Pay now" (Direct Debit)
KBT Klarna Payments "Pay now" (Bank Transfer)
PIV PAYONE Secured Invoice
PDD PAYONE Secured Direct Debit
PIN PAYONE Secured Installment
workorderid
optional
Format CHAR(1..50)

The workorderid is a technical id returned from the PAYONE platform to identify a workorder. A workorder is a part of a payment process (identified by a txid). The workorderid is used for the genericpayment request.

---end

Response Parameters
Permitted Values
APPROVED
ERROR
Response Parameter (approved)
vxid
Format NUMERIC(9..12)

Reference number on the virtual account.

vaid
Format NUMERIC(1..8)

PAYONE User ID, defined by PAYONE

userid
Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE

---end

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)

Billing account ID.

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

---end

Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload               
name-value-pairs
RESPONSE 
your response