- Created by PAYONE Admin, last modified on 2019-05-03
Introduction
With the "preauthorization" request the transmitted amount is reserved. According to the type of payment, specific functions are carried out.
This option is only available in the "Shop" option.
Credit card | Credit card data is verified and stored. |
Debit payment | Account data is verified and stored. |
Online Bank Transfer | Account data is verified |
e-wallet | E-wallet session is initialised |
Prepayment | Data is stored |
Invoice | Data is stored |
Cash on delivery | Data is stored |
Financing | Payment type Klarna require item data, billing and delivery address need to be identical. |
Request "preauthorization" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Common Parameter | Required | Format | Comment | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+ |
Sub-Account ID, defined by PAYONE Format NUMERIC(5..6)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
Merchant reference number for the payment process (case insensitive) 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Individual parameter (per payment process) Format CHAR(1..255)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Dynamic text element on account statements Format CHAR(1..81) (3 lines with 27 characters each) and credit card statements.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
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). Format LIST Permitted Values yes no
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Indicates recurring payments. Currently supported for PayPal and Credit Card payments. Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter (PAYONE Secure Invoice) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
Only valid with “clearingtype=rec”. Used for PAYONE Secure Invoice. Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
Value specifies business relation between merchant and customer Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
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 floor c/o Maier
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Postcode Format CHAR(2..10) Permitted Symbols
[0-9][A-Z][a-z][
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
City of customer Format CHAR(2..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
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. Format LIST Permitted values ISO 3166-2 States (regions) 2-letter-codes Samples US AK AL AR Samples CA AB BC
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
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)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Gender of customer (female / male / diverse* ) Format LIST Permitted values f m d * currently not in use
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Person specific numbers or characters, e.g. number of passport / ID card Format CHAR(1..32) Permitted Symbols
[0-9][A-Z][a-z][+-./()]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Customer's IP-V4-address (123.123.123.123) or IP-V6-address Format CHAR(1..39)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter (delivery data) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
First name of delivery address Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Surname of delivery address Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Company Name of the delivery address Format CHAR(2..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Street number and name of delivery address Format CHAR(2..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Postcode of delivery address Format CHAR(2..10) Permitted Symbols
[0-9][A-Z][a-z][_.-/ ]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier". Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
City of delivery address Format CHAR(2..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
Specifies state of country of delivery address for the customer "shipping_state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN (if shipping_country is given) and must not be used in all other countries. Format LIST Permitted values ISO 3166-2 States (regions) 2-letter-codes Samples US AK AL AR Samples CA AB BC
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Specifies country of delivery address for the customer Format LIST Permitted values ISO 3166 2-letter-codes Samples DE GB US Some countries require additional information in parameter shipping_state
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
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 (online transfer) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Important Notice for Merchants Using Giropay Dear Valued Merchants, We would like to bring to your attention that the configuration outlined below is intended only for merchants who were already supporting Giropay before June 30, 2023. If your merchant contract includes the new Giropay solution, please disregard this configuration and follow the instructions provided here. Reminder: We appreciate your cooperation in ensuring a smooth transition. Should you have any questions or require assistance, please do not hesitate to reach out to our support team. Thank you for your understanding and collaboration.
Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bankcountry | + | Default | Account type/ country (DE, AT, CH, NL, PL) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
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 number (BBAN)
Format NUMERIC(1..10)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
Sort code (BBAN) (only in DE)
Format NUMERIC(8)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
Issuer of Online-Bank-Transfer used for iDEAL and EPS Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
URL for "payment successful" 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" 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" Format CHAR(2..255) Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ip | o | Mandatory for P24 (PAC)
Customer's IP-V4-address (123.123.123.123) or IP-V6-address Format CHAR(1..39)
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter (e-wallet) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
Used with "clearingtype=wlt" to identify wallet payment types Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
URL for "payment successful" 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" 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" Format CHAR(2..255) Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
Parameter it[n] specifies the item type of a shopping cart item. Format LIST Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
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][()[]{} +-_#/:]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
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]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
no[n] |
Quantity of this item Format NUMERIC(6) Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
VAT rate (% or bp) Format NUMERIC(4) Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter (cash on delivery) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
Shipping Provider Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cardissuenumber | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
Cardholder of credit card. Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ecommercemode | - |
Specifies how the payment transaction should be processed - if not default. Format LIST
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter (credit card with pseudo card number) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
Pseudo primary account number for a credit card. Format NUMERIC(16..19)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter (3-D Secure) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
3-D Secure transaction ID (if the request "3dscheck" was used previous transactions), i.e.:
Format CHAR(1..60)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
3-D Secure authentication value Format CHAR(1..40)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
3-D Secure e-commerce indicator Format CHAR(1..2)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
URL for "payment successful" 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" 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" Format CHAR(2..255) Scheme <scheme>://<host>/<path> <scheme>://<host>/<path>?<query> scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter (Financing) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
Used with "clearingtype=fnc" to identify Financing type Format LIST
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o |
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. Format CHAR(1..50)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
Parameter it[n] specifies the item type of a shopping cart item. Format LIST Array Array elements [n] starting with [1]; serially numbered; max [400]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ |
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]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
no[n] | + |
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]
|
Response "preauthorization" | |||
Common Parameter | Required | Format | Comment |
---|---|---|---|
status | + | APPROVED / REDIRECT / ERROR / PENDING | |
Parameter (APPROVED) | |||
+ |
The txid specifies the payment process within the PAYONE platform Format NUMERIC(9..12)
| ||
+ |
PAYONE User ID, defined by PAYONE Format NUMERIC(6..12)
| ||
Parameter (PENDING) (currently only supported for KLV/KLS) | |||
+ |
The txid specifies the payment process within the PAYONE platform Format NUMERIC(9..12)
| ||
+ |
PAYONE User ID, defined by PAYONE Format NUMERIC(6..12)
| ||
Parameter (REDIRECT) (3-D Secure/online transfer/e-wallet) | |||
+ |
The txid specifies the payment process within the PAYONE platform Format NUMERIC(9..12)
| ||
+ |
PAYONE User ID, defined by PAYONE Format NUMERIC(6..12)
| ||
+ |
Redirect URL → zMerchant system has to redirect customer to this URL to complete payment Format CHAR(2..2000)
| ||
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)
| ||
Parameter (credit card – if AVS has been ordered) | |||
protect_result_avs | - | A1 | AVS return value, see AVS-Returns (protect_result_avs) |
Parameter (Prepayment/cash on delivery) | |||
clearing_bankaccountholder | + | AN..35 | Recipient bank account holder |
clearing_bankcountry | + | Default | Recipient account type/ country (e.g. DE, AT, etc.) |
clearing_bankaccount | + | AN..26 | Recipient account number |
clearing_bankcode | o | AN..11 | Recipient sort code |
clearing_bankiban | - | AN..35 | Recipient IBAN |
clearing_bankbic | - | AN..11 | Recipient BIC |
clearing_bankcity | - | AN..50 | Recipient city or bank |
clearing_bankname | - | AN..50 | Recipient bank name |
Parameter (direct debit) | |||
mandate_identification | - | AN..35 |
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
|
mandate_dateofsignature | - | N..10 | date when mandate has been created (format YYYYMMDD) |
creditor_identifier | - | AN..35 | used CID for debit payment |
creditor_name | - | AN..35 | as recorded in PAYONE Platform |
creditor_street | - | AN..35 | as recorded in PAYONE Platform |
creditor_zip | - | AN..10 | as recorded in PAYONE Platform |
creditor_city | - | AN..50 | as recorded in PAYONE Platform |
creditor_country | - | Default | Country (ISO 3166) |
creditor_email | - | AN..254 | as recorded in PAYONE Platform |
Content
- Introduction
- Request "preauthorization"
- Common Parameter
- Parameter (PAYONE Secure Invoice)
- Parameter (personal data)
- Parameter (delivery data)
- Parameter (debit payment)
- Parameter (online transfer)
- Parameter (e-wallet)
- Parameter (cash on delivery)
- Parameter (credit card)
- Parameter (credit card with pseudo card number)
- Parameter (3-D Secure)
- Parameter (Financing)
- Response "preauthorization"
- No labels