- Created by PAYONE Admin on 2019-05-03
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.
Request "vauthorization" | ||||||||||||||||||||||||||||||||||||
Common Parameter | Required | Format | Short explanation | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+ |
Sub-Account ID, defined by PAYONE Format NUMERIC(5..6)
| |||||||||||||||||||||||||||||||||||
+ |
Format LIST
| |||||||||||||||||||||||||||||||||||
+ |
Merchant's transaction reference number Format CHAR(1..20) Permitted Symbols
| |||||||||||||||||||||||||||||||||||
+ |
ID/name of the merchant's billing account Format CHAR(1..20) Permitted Symbols
| |||||||||||||||||||||||||||||||||||
+ |
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. Format NUMERIC(1..10) Permitted values max. +/- 19 999 999 99
| |||||||||||||||||||||||||||||||||||
+ |
Specifies currency for this transaction Format LIST Permitted values ISO 4217 (currencies) 3-letter-codes Samples EUR USD GBP
| |||||||||||||||||||||||||||||||||||
+ |
Length of the accounting period Format NUMERIC(1..3)
| |||||||||||||||||||||||||||||||||||
+ |
Time unit of the accounting period Format LIST
| |||||||||||||||||||||||||||||||||||
- |
Date for the next invoicing Unixtimestamp in the future. Format Unixtimestamp
| |||||||||||||||||||||||||||||||||||
- |
Credits will be booked on the most recent payment process. Format LIST
| |||||||||||||||||||||||||||||||||||
- |
Individual parameter (per payment process) Format CHAR(1..255)
| |||||||||||||||||||||||||||||||||||
Parameter ( Invoicing ) | ||||||||||||||||||||||||||||||||||||
- |
Parameter defines how documents like invoice, credit notes and reminders should be sent to the customer. Format LIST
| |||||||||||||||||||||||||||||||||||
+ |
Product number, SKU, etc. of this item Format CHAR(1..32) Array Array elements [n] starting with [1]; serially numbered; max [400] Permitted Symbols
[0-9][A-Z][a-z][()[]{} +-_#/:]
| |||||||||||||||||||||||||||||||||||
+ |
Unit gross price of the item in smallest unit! e.g. cent Format NUMERIC(10) max. 19 999 999 99 Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||
+ |
Quantity of this item Format NUMERIC(6) Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||
+ |
Description of this item. Will be printed on documents to customer. Format CHAR(1..255) Array Array elements [n] starting with [1]; serially numbered; max [400]
Example Expand source
de[1]=Product 1 de[2]=Product 2 de[3]=Product 3 ... de[400]=Product 400
| |||||||||||||||||||||||||||||||||||
- |
VAT rate (% or bp) Format NUMERIC(4) Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||
- |
Delivery date (YYYYMMDD) Format DATE(8), YYYYMMDD Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||
- |
Delivery period end date (YYYYMMDD) Format DATE(8), YYYYMMDD Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||
Parameter ( personal data ) | ||||||||||||||||||||||||||||||||||||
- |
Merchant's customer ID, defined by you / merchant to refer to the customer record Format CHAR(1..20) Permitted Symbols
[0-9, a-z, A-Z, .,-,_,/]
| |||||||||||||||||||||||||||||||||||
- |
PAYONE User ID, defined by PAYONE Format NUMERIC(6..12)
| |||||||||||||||||||||||||||||||||||
- |
The customer's salutation Format CHAR(1..10)
| |||||||||||||||||||||||||||||||||||
- |
Title of the customer Format CHAR(1..20) Samples Dr Prof. Dr.-Ing.
| |||||||||||||||||||||||||||||||||||
o |
First name of customer; optional if company is used, i.e.: you may use
Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||
+ |
Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50)
| |||||||||||||||||||||||||||||||||||
- |
Company name of customer; The company name is optional if lastname is used, i.e.: you may use
Format CHAR(2..50)
| |||||||||||||||||||||||||||||||||||
- |
Street number and name (required: at least one character) Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||
- |
Specifies an additional address line for the invoice address of the customer. Format CHAR(1..50) Samples 7th floorc/o Maier
| |||||||||||||||||||||||||||||||||||
- |
Postcode Format CHAR(2..10) Permitted Symbols
[0-9][A-Z][a-z][
| |||||||||||||||||||||||||||||||||||
- |
City of customer Format CHAR(2..50)
| |||||||||||||||||||||||||||||||||||
+ | ||||||||||||||||||||||||||||||||||||
- |
email-address of customer 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:
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.
| |||||||||||||||||||||||||||||||||||
- |
Phone number of customer Format CHAR(1..30)
| |||||||||||||||||||||||||||||||||||
- |
Date of birth of customer Format DATE(8), YYYYMMDD Samples 20190101 19991231
| |||||||||||||||||||||||||||||||||||
- |
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
| |||||||||||||||||||||||||||||||||||
- |
VAT identification number. Used for b2b transactions to indicate VAT number of customer. Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||
- |
Customer's IP-V4-address (123.123.123.123) or IP-V6-address Format CHAR(1..39)
| |||||||||||||||||||||||||||||||||||
Parameter ( debit payment ) | ||||||||||||||||||||||||||||||||||||
o |
IBAN to be used for payment or to be checked Format CHAR(10..34) Permitted Symbols
[0-9][A-Z]
| |||||||||||||||||||||||||||||||||||
o |
Bank Identifier Code to be used for payment or to be checked 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.
| |||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||
o |
Account number (BBAN)
Format NUMERIC(1..10)
| |||||||||||||||||||||||||||||||||||
o |
Sort code (BBAN) (only in DE)
Format NUMERIC(8)
| |||||||||||||||||||||||||||||||||||
- |
Account holder Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||
o |
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. Format CHAR(1..35) Permitted Symbols
[A-Z,a-z,0-9,+,-,.,(,)] 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
| |||||||||||||||||||||||||||||||||||
Parameter ( credit card ) | ||||||||||||||||||||||||||||||||||||
+ |
Primary account number of credit card Format NUMERIC(13..19)
| |||||||||||||||||||||||||||||||||||
+ |
Card type of credit card Format LIST
*girocard is currently only viable for e-commerce-payments via Apple Pay.
| |||||||||||||||||||||||||||||||||||
+ |
Credit card expiry date YYMM Format NUMERIC(4), YYMM
| |||||||||||||||||||||||||||||||||||
o |
Credit card security number Format NUMERIC(3..4) For SAQ A compliance: PAYONE Frontend hosted iFrame must be used. This parameter must not be used.
| |||||||||||||||||||||||||||||||||||
- |
Card issue number (only Maestro UK cards) Format NUMERIC(1..2)
| |||||||||||||||||||||||||||||||||||
- |
Cardholder of credit card. Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||
Parameter ( credit card with pseudo card number ) | ||||||||||||||||||||||||||||||||||||
+ |
Pseudo primary account number for a credit card. Format NUMERIC(16..19)
| |||||||||||||||||||||||||||||||||||
Response "vauthorization" | |||
|---|---|---|---|
Common Parameter | Required | Format | Short explanation |
status | + | Default | APPROVED / ERROR |
Parameter (APPROVED) | |||
+ |
Reference number on the virtual account Format NUMERIC(9..12)
| ||
+ |
Billing account ID Format NUMERIC(1..8)
| ||
+ |
PAYONE User ID, defined by PAYONE Format NUMERIC(6..12)
| ||
Parameter (ERROR) | |||
+ |
In case of error the PAYONE Platform returns an error code for your internal usage. Format NUMERIC(1..6)
| ||
+ |
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") Format CHAR(1..1024)
| ||
Content
- No labels