Additional Parameters
Customer Parameters
Consumer Data
These parameters are used to pass on detailed information to the consumer and some specific payment methods are required.
Parameter | Data type | Description | ||
---|---|---|---|---|
Alphanumeric with special characters, up to 256 characters. |
Consumer email address. |
|||
|
Alphanumeric, up to 30 characters. |
Account ID of the consumer’s specific wallet system. |
||
|
Alphanumeric, up to 30 characters. |
Type/name of the specific wallet system of the consumer. |
||
Numeric with special characters, fixed-length 10. |
Date of birth of the consumer |
|||
|
Alphanumeric with special characters, up to 32 characters. |
Tax identification number of the consumer. |
||
|
Alphanumeric with special characters, up to 100 characters. |
Company name of the consumer. |
||
|
Alphanumeric with special characters, up to 50 characters. |
Company register number of the consumer’s company. |
||
|
Alphanumeric with special characters, up to 32 characters. |
Consumer’s driver’s license number. |
||
|
Alphabetic, fixed length of 2 characters. |
Country (ISO 3166-1) in which the consumer’s driver’s license was issued. |
||
|
Alphabetic, with a fixed length of 2 for the US and CA; otherwise, up to 40. |
State in which the consumer’s driver’s license was issued [1] |
||
Alphabetic, fixed 2 characters. |
Consumer language. |
|||
|
Alphanumeric with special characters, up to 4096 characters. |
Device ID of the consumer.
|
||
Alphanumeric, with special characters. |
IP address of the consumer. |
|||
Alphanumeric, up to 50 characters. |
The merchant CRM ID of the consumer. |
|||
Alphanumeric with special characters, up to 100 characters. |
Company name of the customer. |
|||
Alphanumeric with special characters, up to 50 characters. |
VAT identification number of the customer. |
|||
Alphanumeric with special characters, up to 50 characters. |
Company register/commercial register number of the customer. |
|||
Alphanumeric with special characters, up to 50 characters. |
Other company registration number of the customer. |
|||
Enumeration. |
Registration method of the consumer.
|
|||
Timestamp. |
Time of registration (login) of the consumer in the store.
|
|||
Numeric with special characters, fixed length of 10. |
Registration date of the consumer’s card in the store account (for "card-on-file" and "one-click-checkout" transactions).
|
|||
Numeric, up to 9 characters. |
Card registration attempts of the last 24 hours of the consumer in the store account (for "card-on-file" and "one-click-checkout" transactions). |
|||
Enumeration. |
Indicator whether Strong Customer Authentication (SCA) is required for this transaction.
|
|||
Numeric with special characters, fixed length of 10. |
Creation date of the consumer account.
|
|||
Numeric with special characters and a fixed length of 10. |
Date of the last change of the consumer’s password.
|
|||
Numeric, up to 9 characters. |
Number of purchases within the consumer’s last six months. |
|||
Boolean. |
Suspicious activities of the consumer |
|||
Numeric, up to 9 characters. |
Number of attempted transactions by the consumer within 24 hours (successful, failed and aborted transactions). |
|||
Numeric, up to 9 characters. |
Number of transactions attempted by the consumer within the last year (successful, failed, and aborted transactions). |
|||
Numeric with special characters, fixed length of 10. |
Date of the last change to the consumer account (e.g. changes to the billing address, delivery address or e-mail address).
|
|||
Enumeration. |
Time window of delivery.
|
|||
Numeric with special characters, fixed length of 10. |
Date of availability for pre-ordered items. |
|||
Enumeration. |
Reordered item
|
|||
Alphanumeric, with up to 3 characters. |
Number of days between authorizations. |
|||
String. |
Date after which no more authorizations are to be executed. |
CONSUMER_EMAIL |
|||
---|---|---|---|
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 256 characters. |
||
Description |
Consumer email address. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric, up to 30 characters. |
||
Description |
Account ID of the consumer’s specific wallet system. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric, up to 30 characters. |
||
Description |
Type/name of the specific wallet system of the consumer. |
||
Data |
Value |
||
Data type |
Numeric with special characters, fixed-length 10. |
||
Description |
Date of birth of the consumer |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 32 characters. |
||
Description |
Tax identification number of the consumer. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 100 characters. |
||
Description |
Company name of the consumer. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 50 characters. |
||
Description |
Company register number of the consumer’s company. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 32 characters. |
||
Description |
Consumer’s driver’s license number. |
||
|
|||
Data |
Value |
||
Data type |
Alphabetic, fixed length of 2 characters. |
||
Description |
Country (ISO 3166-1) in which the consumer’s driver’s license was issued. |
||
|
|||
Data |
Value |
||
Data type |
Alphabetic, with a fixed length of 2 for the US and CA; otherwise, up to 40. |
||
Description |
State in which the consumer’s driver’s license was issued [2] |
||
Data |
Value |
||
Data type |
Alphabetic, fixed 2 characters. |
||
Description |
Consumer language. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 4096 characters. |
||
Description |
Device ID of the consumer.
|
||
Data |
Value |
||
Data type |
Alphanumeric, with special characters. |
||
Description |
IP address of the consumer. |
||
Data |
Value |
||
Data type |
Alphanumeric, up to 50 characters. |
||
Description |
The merchant CRM ID of the consumer. |
||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 100 characters. |
||
Description |
Company name of the customer. |
||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 50 characters. |
||
Description |
VAT identification number of the customer. |
||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 50 characters. |
||
Description |
Company register/commercial register number of the customer. |
||
Data |
Value |
||
Data type |
Alphanumeric with special characters, up to 50 characters. |
||
Description |
Other company registration number of the customer. |
||
Data |
Value |
||
Data type |
Enumeration. |
||
Description |
Registration method of the consumer. |
||
Data |
Value |
||
Data type |
Timestamp. |
||
Description |
Time of registration (login) of the consumer in the store.
|
||
Data |
Value |
||
Data type |
Numeric with special characters, fixed length of 10. |
||
Description |
Registration date of the consumer’s card in the store account (for "card-on-file" and "one-click-checkout" transactions).
|
||
Data |
Value |
||
Data type |
Numeric, up to 9 characters. |
||
Description |
Card registration attempts of the last 24 hours of the consumer in the store account (for "card-on-file" and "one-click-checkout" transactions). |
||
Data |
Value |
||
Data type |
Enumeration. |
||
Description |
Indicator whether Strong Customer Authentication (SCA) is required for this transaction. NOTE: If the element is not provided, the ACS interprets this as |
||
Data |
Value |
||
Data type |
Numeric with special characters, fixed length of 10. |
||
Description |
Creation date of the consumer account.
|
||
Data |
Value |
||
Data type |
Numeric with special characters and a fixed length of 10. |
||
Description |
Date of the last change of the consumer’s password.
|
||
Data |
Value |
||
Data type |
Numeric, up to 9 characters. |
||
Description |
Number of purchases within the consumer’s last six months. |
||
Data |
Value |
||
Data type |
Boolean. |
||
Description |
Suspicious activities of the consumer |
||
Data |
Value |
||
Data type |
Numeric, up to 9 characters. |
||
Description |
Number of attempted transactions by the consumer within 24 hours (successful, failed and aborted transactions). |
||
Data |
Value |
||
Data type |
Numeric, up to 9 characters. |
||
Description |
Number of transactions attempted by the consumer within the last year (successful, failed, and aborted transactions). |
||
Data |
Value |
||
Data type |
Numeric with special characters, fixed length of 10. |
||
Description |
Date of the last change to the consumer account (e.g. changes to the billing address, delivery address or e-mail address).
|
||
Data |
Value |
||
Data type |
Enumeration. |
||
Description |
Time window of delivery. |
||
Data |
Value |
||
Data type |
Numeric with special characters, fixed length of 10. |
||
Description |
Date of availability for pre-ordered items. |
||
Data |
Value |
||
Data type |
Enumeration. |
||
Description |
Reordered item |
||
Data |
Value |
||
Data type |
Alphanumeric, with up to 3 characters. |
||
Description |
Number of days between authorizations. |
||
Data |
Value |
||
Data type |
String. |
||
Description |
Date after which no more authorizations are to be executed. |
Consumer Billing Data
Parameter | Data type | Description |
---|---|---|
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
Billing address first name. |
|
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
Billing address last name. |
|
Alphanumeric, up to 100 bytes. |
Billing address part 1. |
|
|
Alphanumeric, up to 100 bytes. |
Billing address part 2. |
|
Alphanumeric, up to 100 bytes. |
Billing address part 3. |
Alphanumeric, up to 32 bytes. |
Billing address location. |
|
Alphanumeric, up to 12 characters. |
Zip code of the billing address. |
|
|
If the |
State of billing address [1]. |
Alphabetic, fixed 2 characters. |
Country (ISO 3166-1) of the billing address. |
|
Alphanumeric, up to 20 characters. |
Billing address phone number. |
|
|
Alphanumeric, up to 18 characters. |
Mobile phone number of the billing address. |
|
Alphanumeric, up to 20 characters. |
Billing address fax number. |
CONSUMER_BILLING_FIRST_NAME |
|
---|---|
Data |
Value |
Data type |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
Description |
Billing address first name. |
Data |
Value |
Data type |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
Description |
Billing address last name. |
Data |
Value |
Data type |
Alphanumeric, up to 100 bytes. |
Description |
Billing address part 1. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 100 bytes. |
Description |
Billing address part 2. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 100 bytes. |
Description |
Billing address part 3. |
Data |
Value |
Data type |
Alphanumeric, up to 32 bytes. |
Description |
Billing address location. |
Data |
Value |
Data type |
Alphanumeric, up to 12 characters. |
Description |
Zip code of the billing address. |
|
|
Data |
Value |
Data type |
If the |
Description |
State of billing address [1]. |
Data |
Value |
Data type |
Alphabetic, fixed 2 characters. |
Description |
Country (ISO 3166-1) of the billing address. |
Data |
Value |
Data type |
Alphanumeric, up to 20 characters. |
Description |
Billing address phone number. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 18 characters. |
Description |
Mobile phone number of the billing address. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 20 characters. |
Description |
Billing address fax number. |
Consumer Shipping Data
Parameter | Data type | Description | ||
---|---|---|---|---|
|
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
First name of the delivery address. |
||
|
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
Last name of the delivery address. |
||
|
Alphanumeric, up to 100 bytes. |
Delivery address part 1. |
||
|
Alphanumeric, up to 100 bytes. |
Delivery address part 2. |
||
|
Alphanumeric, up to 32 bytes. |
Place of the delivery address. |
||
|
Alphanumeric, up to 12. |
Zip code of the delivery address. |
||
|
If the consumerShippingCountry is US or CA-Alphabetic, fixed 2 characters and can’t be empty. |
State of the delivery address [1]. |
||
Alphabetic, fixed 2 characters. |
Country (ISO 3166-1) of the delivery address. |
|||
|
Alphanumeric, up to 20. |
Delivery address phone number. |
||
|
Alphanumeric, up to 20. |
Fax number of the delivery address. |
||
Enumeration. |
The delivery method is chosen by the consumer. Use the value that is most appropriate for the delivery method. Accepted values:
|
|||
Numeric with special characters, fixed 10. |
Date of the first use of the consumer’s delivery address in the store.
|
|||
Enumeration. |
Availability of the article.
|
CONSUMER_SHIPPING_FIRST_NAME |
|||
---|---|---|---|
Data |
Value |
||
Data type |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
||
Description |
First name of the delivery address. |
||
|
|||
Data |
Value |
||
Data type |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
||
Description |
Last name of the delivery address. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric, up to 100 bytes. |
||
Description |
Delivery address part 1. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric, up to 100 bytes. |
||
Description |
Delivery address part 2. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric, up to 32 bytes. |
||
Description |
Place of the delivery address. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric, up to 12. |
||
Description |
Zip code of the delivery address. |
||
|
|||
Data |
Value |
||
Data type |
If the consumerShippingCountry is US or CA-Alphabetic, fixed 2 characters and can’t be empty. |
||
Description |
State of the delivery address [1]. |
||
Data |
Value |
||
Data type |
Alphabetic, fixed 2 characters. |
||
Description |
Country (ISO 3166-1) of the delivery address. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric, up to 20. |
||
Description |
Delivery address phone number. |
||
|
|||
Data |
Value |
||
Data type |
Alphanumeric, up to 20. |
||
Description |
Fax number of the delivery address. |
||
Data |
Value |
||
Data type |
Enumeration. |
||
Description |
The delivery method is chosen by the consumer. |
||
Data |
Value |
||
Data type |
Numeric with special characters, fixed 10. |
||
Description |
Date of the first use of the consumer’s delivery address in the store.
|
||
Data |
Value |
||
Data type |
Enumeration. |
||
Description |
Availability of the article. |
Consumer Browser Data
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special, up to 4096 characters. |
Number (M) of subsequent HTTP request header elements. |
|
Alphanumeric with special characters, up to 100 characters. |
Name of the m-th HTTP request header, where m ∈ {1…M}. |
|
Value of the HTTP request header. |
HTTP_HEADERS |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with special characters, up to 100 characters. |
Description |
Number (M) of subsequent HTTP request header elements. |
|
|
Data |
Value |
Data type |
Alphanumeric with special, up to 4096 characters. |
Description |
Name of the m-th HTTP request header, where m ∈ {1…M}. |
`HTTP_HEADER_<m>_VALUE ` |
|
Data |
Value |
Data type |
|
Description |
Value of the HTTP request header. |
Basket Items Data
Parameters that allow passing on detailed information about the content of the consumer’s shopping basket. By default are optional, but for some specific payment methods like invoice or installment are required.
Although the following parameters are optional, all parameters need to be set, except for BASKET_ITEM_<m>_DESCRIPTION and BASKET_ITEM_<m>_IMAGE_URL which remain optional, or none.
|
Although the following parameters are optional, all parameters need to be set, except for BASKET_ITEM_<m>_DESCRIPTION and BASKET_ITEM_<m>_IMAGE_URL which remain optional, or none.
|
Parameter | Data Type | Description |
---|---|---|
Numeric. |
Number (M) of items in the shopping cart. |
|
Alphanumeric with special characters. |
Item number of the m-th item, where m ∈ {1…M}. |
|
Alphanumeric with special characters. |
Description of the m-th item. |
|
Alphanumeric with special characters. |
URL to a product image of the m-th item. |
|
|
Alphanumeric with special characters. |
Product name of the m-th item. |
|
Numeric. |
Number of m-th item. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Gross unit price of the m-th single item. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Net unit price of the m-th single item. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Tax unit price of the m-th single item. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Tax rate of the m-th item. |
Set possible shipping costs as a separate BASKET_ITEM ; otherwise, the validation of the sum of the individual items and the total sum will fail. If different shipping costs apply to the different articles in the basket, the individual shipping costs must be stated as separate BASKET_ITEM .
|
Example of basket parameters for a shopping basket
The following simple example is intended to contribute to a better understanding of how to set the basket parameters.
The parameters for describing the items in the shopping basket of the consumer would be:
Browser Parameters
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special, up to 4096 characters, anything that can be in the HTTP header of a browser. |
HTTP header of the consumer’s browser. When passed, the |
|
Numeric(2), fixed length 5. |
Size of the challenge window.
|
|
Numeric, up to 2 digits. |
Color depth.
|
|
Boolean. |
Java Activation (Boolean yes/no, 1/0). |
|
Alphabetic, up to 8 characters. |
Browser language. |
|
Alphabetic, up to 9 characters. |
Screen resolution. |
|
Numbers in the range between -720 to 720. |
Browser time zone. |
|
Alphanumeric with special characters, up to 128 characters. |
User Agent. |
|
Boolean. |
Javascript Enable (Boolean). |
BROWSER_ACCEPT_HEADERS |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with special, up to 4096 characters, anything that can be in the HTTP header of a browser. |
Description |
HTTP header of the consumer’s browser. |
|
|
Data |
Value |
Data type |
Numeric(2), fixed length 5. |
Description |
Size of the challenge window. |
|
|
Data |
Value |
Data type |
Numeric, up to 2 digits. |
Description |
Color depth. |
|
|
Data |
Value |
Data type |
Boolean. |
Description |
Java Activation (Boolean yes/no, 1/0). |
|
|
Data |
Value |
Data type |
Alphabetic, up to 8 characters. |
Description |
Browser language. |
|
|
Data |
Value |
Data type |
Alphabetic, up to 9 characters. |
Description |
Screen resolution. |
|
|
Data |
Value |
Data type |
Numbers in the range between -720 to 720. |
Description |
Browser time zone. |
|
|
Data |
Value |
Data type |
Alphanumeric with special characters, up to 128 characters. |
Description |
User Agent. |
|
|
Data |
Value |
Data type |
Boolean. |
Description |
Javascript Enable (Boolean). |
Recipient Parameters
Parameter | Data Type | Description |
---|---|---|
|
Numeric with special characters, fixed-length 10. |
Date of birth in the format |
|
Numeric, up to 19 digits. |
Recipient’s credit card number. |
|
Alphanumeric, up to 12 characters. |
The first 6 digits of the postal code. |
|
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
The first 6 digits of the recipient’s last name. |
RECIPIENT_BIRTH_DATE |
|
---|---|
Data |
Value |
Data type |
Numeric with special characters, fixed-length 10. |
Description |
Date of birth in the format |
|
|
Data |
Value |
Data type |
Numeric, up to 19 digits |
Description |
Recipient’s credit card number. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 12 characters. |
Description |
The first 6 digits of the postal code. |
|
|
Data |
Value |
Data type |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes. |
Description |
The first 6 digits of the recipient’s last name. |
Object Properties in the Response
There are three types of object properties in the response:
Orders as a Basis
This type is returned for the operations VERIFYPAYMENT, GETORDERDETAILS, QUERYORDERS, queryPayments
, provided that no error occurred during the operation itself (status=0).
Some parameters will occur more than once, so we use the letters n and m as placeholders for digits. Currently, n is always 1 because the operation returns only one order and m indicates that there may be more than one payment or credit object returned. |
Parameter | Data Type | Description |
---|---|---|
|
Numeric, fixed 9 digits. |
Merchant number. |
|
Numeric, up to 9 digits. |
Order number. |
|
Alphanumeric, up to 32 characters. |
Payment type. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Amount |
|
Alphanumeric, up to 255 characters. |
Brand |
|
Alphabetic or numeric, fixed 3 characters. |
ISO currency code |
|
Alphanumeric, up to 255 characters. |
Order description |
|
Date |
Time of creation, |
|
Date |
Time of the last change, |
Alphanumeric, up to 16 characters. |
Status of the order ( |
|
|
Numeric |
Number of assigned payment objects. |
|
Numeric |
Number of assigned credit objects. |
order.<n>.merchantNumber |
|
---|---|
Data |
Value |
Data type |
Numeric, fixed 9 digits. |
Description |
Merchant number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Order number. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 32 characters. |
Description |
Payment type. |
|
|
Data |
Value |
Data type |
Numeric with special characters(dot,comma), up to 20 characters. |
Description |
Amount |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 255 characters. |
Description |
Brand |
|
|
Data |
Value |
Data type |
Alphabetic or numeric, fixed 3 characters. |
Description |
ISO currency code |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 255 characters. |
Description |
Order description |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of creation, |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of the last change, |
Data |
Value |
Data type |
Alphanumeric, up to 16 characters. |
Description |
Status of the order ( |
|
|
Data |
Value |
Data type |
Numeric |
Description |
Number of assigned payment objects. |
|
|
Data |
Value |
Data type |
Numeric |
Description |
Number of assigned credit objects. |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric |
Acquirer |
|
Alphanumeric including special characters, up to 255 characters. |
Contract number used with the financial service provider. |
|
Alphanumeric including special characters. |
Permitted subsequent operations separated by commas. Empty if no operation is possible. |
|
Numeric, up to 128 digits. |
Order reference. |
|
Alphanumeric, up to 254 characters that may be restricted for specific payment methods. |
Text on the customer document. |
Alphanumeric with special characters, up to 255 characters. |
Cleaned order description, which contains only ASCII text. |
|
|
Numeric, up to 9 digits. |
Source order number, if chaining to another order exists. |
|
Alphanumeric including special characters, up to 255 characters. |
Merchant Account ID (MAID). |
order.<n>.acquirer |
|
---|---|
Data |
Value |
Data type |
Alphanumeric |
Description |
Acquirer |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Contract number used with the financial service provider. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters. |
Description |
Permitted subsequent operations separated by commas. Empty if no operation is possible. |
|
|
Data |
Value |
Data type |
Numeric, up to 128 digits. |
Description |
Order reference. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 254 characters that may be restricted for specific payment methods. |
Description |
Text on the customer document. |
Data |
Value |
Data type |
Alphanumeric with special characters, up to 255 characters. |
Description |
Cleaned order description, which contains only ASCII text. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Source order number, if chaining to another order exists. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Merchant Account ID (MAID). |
Parameter | Data Type | Description |
---|---|---|
|
Numeric |
Merchant number. |
|
Numeric, up to 9 digits. |
Payment number. |
|
Numeric, up to 9 digits. |
Order number. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Approved amount of this payment. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Deposited amount of this payment. |
|
Alphabetic or numeric, fixed 3 characters. |
ISO currency code. |
|
Date |
Time of creation, |
|
Date |
Time of the last change, |
Alphabetic, up to 32 characters. |
Status of payment ( |
|
|
Alphanumeric, up to 64 characters. |
Payment type |
payment.<n>.<m>.merchantNumber |
|
---|---|
Data |
Value |
Data type |
Numeric |
Description |
Merchant number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Payment number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Order number. |
|
|
Data |
Value |
Data type |
Numeric with special characters(dot,comma), up to 20 characters. |
Description |
Approved amount of this payment. |
|
|
Data |
Value |
Data type |
Numeric with special characters(dot,comma), up to 20 characters. |
Description |
Deposited amount of this payment. |
|
|
Data |
Value |
Data type |
Alphabetic or numeric, fixed 3 characters. |
Description |
ISO currency code. |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of creation, |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of the last change, |
Data |
Value |
Data type |
Alphabetic, up to 32 characters. |
Description |
Status of payment ( |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 64 characters. |
Description |
Payment type |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric |
Approval code from the financial service provider can also be empty. |
|
Numeric, up to 9 digits. |
Only included if payment is already assigned to a daily closing (= deposited). |
|
Alphanumeric including special characters. |
Permitted subsequent operations separated by commas. |
|
Alphanumeric including special characters, up to 255 characters. |
Reference number of the respective payment gateway/financial service provider (does not have to be numeric). |
|
ASCII up to 128 characters, but may differ for specific payment methods. |
Merchant reference of the booking. |
|
Alphabetic, fixed 2 characters. |
Country code country of issue of the means of payment. |
|
Alphanumeric including special characters, up to 255 characters. |
Provider reference for booking. |
payment.<n>.<m>.approvalCode |
|
---|---|
Data |
Value |
Data type |
Alphanumeric |
Description |
Approval code from the financial service provider can also be empty. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Only included if payment is already assigned to a daily closing (= deposited). |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters. |
Description |
Permitted subsequent operations separated by commas. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Reference number of the respective payment gateway/financial service provider (does not have to be numeric). |
|
|
Data |
Value |
Data type |
ASCII up to 128 characters, but may differ for specific payment methods. |
Description |
Merchant reference of the booking. |
|
|
Data |
Value |
Data type |
Alphabetic, fixed 2 characters. |
Description |
Country code country of issue of the means of payment. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Provider reference for booking. |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters, up to 255. |
Consumer name. |
|
Alphanumeric, up to 50. |
BIC of the customer. |
|
Alphanumeric, up to 50. |
IBAN of the customer. |
payment.<n>.<m>.epsConsumerName |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with special characters, up to 255. |
Description |
Consumer name. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 50. |
Description |
BIC of the customer. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 50. |
Description |
IBAN of the customer. |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, up to 13 characters. |
ID of the PayPal consumer. |
|
Alphanumeric including special characters, up to 127 characters. |
PayPal consumer email. |
|
Alphanumeric, up to 64 characters. |
PayPal consumer first name. |
|
Alphanumeric, up to 64 characters. |
Last name of the PayPal consumer. |
|
Alphabetic, up to 50 characters. |
Country of the PayPal consumer. |
|
Alphabetic, fixed 2 characters. |
Country (ISO 3166-1) of the PayPal consumer. |
|
Alphabetic, up to 40 characters. |
PayPal consumer city. |
|
Alphabetic, fixed 2 characters. |
State of the PayPal consumer. |
|
Alphanumeric, up to 100 characters. |
Address name of the PayPal consumer. |
|
Alphanumeric, up to 100 characters. |
Street (1) of the PayPal consumer. |
|
Alphanumeric, up to 100 characters. |
Street (2) of the PayPal consumer. |
|
Alphanumeric, up to 32 characters. |
Zip code of the PayPal consumer. |
|
Alphanumeric, up to 32 characters. |
Status of the address verification of the PayPal consumer. |
|
Alphanumeric, up to 32 characters. |
Seller protection information. |
|
Alphanumeric including special characters, up to 19 characters. |
Billing agreement ID created by PayPal which can be used for recurring payments. |
payment.<n>.<m>.paypalPayerID |
|
---|---|
Data |
Value |
Data type |
Alphanumeric, up to 13 characters. |
Description |
ID of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 127 characters. |
Description |
PayPal consumer email. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 64 characters. |
Description |
PayPal consumer first name. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 64 characters. |
Description |
Last name of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphabetic, up to 50 characters. |
Description |
Country of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphabetic, fixed 2 characters. |
Description |
Country (ISO 3166-1) of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphabetic, up to 40 characters. |
Description |
PayPal consumer city. |
|
|
Data |
Value |
Data type |
Alphabetic, fixed 2 characters. |
Description |
State of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 100 characters. |
Description |
Address name of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 100 characters. |
Description |
Street (1) of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 100 characters. |
Description |
Street (2) of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 32 characters. |
Description |
Zip code of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 32 characters. |
Description |
Status of the address verification of the PayPal consumer. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 32 characters. |
Description |
Seller protection information. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 19 characters. |
Description |
Billing agreement ID created by PayPal which can be used for recurring payments. |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric including special characters, up to 255 characters. |
Name of the sender account. |
|
Alphanumeric including special characters, up to 255 characters. |
Sender’s account number. |
|
Numeric, up to 30 digits. |
Sender bank code. |
|
Numeric, up to 30 digits. |
Name of the sender’s bank. |
|
Alphabetic, fixed 2 characters. |
Country of the sender account. |
payment.<n>.<m>.senderAccountOwner |
|
---|---|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Name of the sender account. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Sender’s account number. |
|
|
Data |
Value |
Data type |
Numeric, up to 30 digits. |
Description |
Sender bank code. |
|
|
Data |
Value |
Data type |
Numeric, up to 30 digits. |
Description |
Name of the sender’s bank. |
|
|
Data |
Value |
Data type |
Alphabetic, fixed 2 characters. |
Description |
Country of the sender account. |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, up to 50 characters. |
BIC of the sender account. |
|
Alphanumeric, up to 50 characters. |
IBAN of the sender account. |
|
Numeric with a fixed length of 1 digit. |
Safety criterion met. |
payment.<n>.<m>.senderBIC |
|
---|---|
Data |
Value |
Data type |
Alphanumeric, up to 50 characters. |
Description |
BIC of the sender account. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 50 characters. |
Description |
IBAN of the sender account. |
|
|
Data |
Value |
Data type |
Numeric with a fixed length of 1 digit. |
Description |
Safety criterion met. |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, up to 35 characters. |
Mandate reference used. |
|
Date as |
Mandate signature date. |
|
Date as |
Planned date of execution of the direct debit. |
|
Alphanumeric, up to 35. |
Merchant identifier used. |
payment.<n>.<m>.mandateID |
|
---|---|
Data |
Value |
Data type |
Alphanumeric, up to 35 characters. |
Description |
Mandate reference used. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 35 characters. |
Description |
Mandate signature date. |
|
|
Data |
Value |
Data type |
Date as |
Description |
Merchant identifier used. |
Parameter | Data Type | Description |
---|---|---|
|
Numeric |
Merchant number. |
|
Numeric, up to 9 digits. |
Credit note number. |
|
Numeric, up to 9 digits. |
Order number. |
|
Numeric, up to 9 digits. |
Associated daily closing number. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Amount of the credit note. |
|
Alphabetic or numeric, fixed 3 characters. |
ISO currency code. |
|
Date |
Time of creation, |
|
Date |
Time of modification, |
|
Alphabetic including special characters. |
Status of credit note ( |
credit.<n>.<m>.merchantNumber |
|
---|---|
Data |
Value |
Data type |
Numeric |
Description |
Merchant number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Credit note number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Order number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Associated daily closing number. |
|
|
Data |
Value |
Data type |
Numeric with special characters(dot,comma), up to 20 characters. |
Description |
Amount of the credit note. |
|
|
Data |
Value |
Data type |
Alphabetic or numeric, fixed 3 characters. |
Description |
ISO currency code. |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of creation, |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of modification, |
|
|
Data |
Value |
Data type |
Alphabetic including special characters. |
Description |
Status of credit note ( |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric including special characters. |
Permitted subsequent operations separated by commas. Empty if no operations are possible. |
|
Alphanumeric including special characters, up to 255 characters. |
Reference number of the respective payment gateway/financial service provider (does not have to be numeric). |
|
ASCII up to 128 characters, but may differ for specific payment methods. |
Merchant reference of the credit note. |
|
Alphanumeric including special characters, up to 255 characters. |
Provider reference of the credit note. |
credit.<n>.<m>.operationsAllowed |
|
---|---|
Data |
Value |
Data type |
Alphanumeric including special characters. |
Description |
Permitted subsequent operations separated by commas. Empty if no operations are possible. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Reference number of the respective payment gateway/financial service provider (does not have to be numeric). |
|
|
Data |
Value |
Data type |
ASCII up to 128 characters, but may differ for specific payment methods. |
Description |
Merchant reference of the credit note. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Provider reference of the credit note. |
Credit Notes as a Basis
This type is returned in the QUERYCREDITS operation, provided that no error occurred in the operation itself (status=0).
Parameter | Data Type | Description |
---|---|---|
|
Numeric |
Merchant number. |
|
Numeric, up to 9 digits. |
Credit note number. |
|
Numeric, up to 9 digits. |
Order number. |
|
Numeric, up to 9 digits. |
Associated daily closing number. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Amount of the credit note. |
|
Alphabetic or numeric, fixed 3 characters. |
ISO currency code. |
|
Date |
Time of creation, |
|
Date |
Time of modification, |
Alphabetic including special characters. |
Status of credit note ( |
credit.<n>.merchantNumber |
|
---|---|
Data |
Value |
Data type |
Numeric |
Description |
Merchant number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Credit note number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Order number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Associated daily closing number. |
|
|
Data |
Value |
Data type |
Numeric with special characters(dot,comma), up to 20 characters. |
Description |
Amount of the credit note. |
|
|
Data |
Value |
Data type |
Alphabetic or numeric, fixed 3 characters. |
Description |
ISO currency code. |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of creation, |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of modification, |
Data |
Value |
Data type |
Alphabetic including special characters. |
Description |
Status of credit note ( |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric including special characters. |
Permitted subsequent operations separated by commas. Empty if no operations are possible. |
|
Alphanumeric including special characters, up to 255 characters. |
Reference number of the respective payment gateway/financial service provider (does not have to be numeric). |
|
ASCII up to 128 characters, but may differ for specific payment methods. |
Merchant reference of the credit note. |
credit.<n>.operationsAllowed |
|
---|---|
Data |
Value |
Data type |
Alphanumeric including special characters. |
Description |
Permitted subsequent operations separated by commas. Empty if no operations are possible. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Reference number of the respective payment gateway/financial service provider (does not have to be numeric). |
|
|
Data |
Value |
Data type |
ASCII up to 128 characters, but may differ for specific payment methods. |
Description |
Merchant reference of the credit note. |
Parameter | Data Type | Description |
---|---|---|
|
Numeric, fixed 9 digits. |
Merchant number. |
|
Numeric, up to 9 digits. |
Order number. |
|
Alphanumeric, up to 32 characters. |
Payment type. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Amount. |
|
Alphanumeric, up to 255 characters. |
Brand |
|
Alphabetic or numeric, fixed 3 characters. |
ISO currency code. |
|
Alphanumeric, up to 255 characters. |
Order description |
|
Date |
Time of creation, |
|
Date |
Time of the last change, |
|
Alphanumeric, up to 16 characters. |
Status of the order ( |
order.<n>.1.merchantNumber |
|
---|---|
Data |
Value |
Data type |
Numeric, fixed 9 digits. |
Description |
Merchant number. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Order number. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 32 characters. |
Description |
Payment type. |
|
|
Data |
Value |
Data type |
Numeric with special characters(dot,comma), up to 20 characters. |
Description |
Amount. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 255 characters. |
Description |
Brand |
|
|
Data |
Value |
Data type |
Alphabetic or numeric, fixed 3 characters. |
Description |
ISO currency code. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 255 characters. |
Description |
Order description |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of creation, |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of the last change, |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 16 characters. |
Description |
Status of the order ( |
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric |
Acquirer. |
|
Alphanumeric including special characters, up to 255 characters. |
Contract number used with the financial service provider. |
|
Alphanumeric including special characters. |
Permitted subsequent operations separated by commas. Empty if no operation is possible. |
|
Numeric, up to 128 digits. |
Order reference. |
|
Alphanumeric, up to 254 characters that may be restricted for specific payment methods. |
Text on the customer document. |
|
Alphanumeric with special characters, up to 255 characters. |
Cleaned order description, which contains only ASCII text. |
|
Numeric, up to 9 digits. |
Source order number, if chaining to another order exists. |
order.<n>.1.acquirer |
|
---|---|
Data |
Value |
Data type |
Alphanumeric |
Description |
Acquirer. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Contract number used with the financial service provider. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters. |
Description |
Permitted subsequent operations separated by commas. Empty if no operation is possible. |
|
|
Data |
Value |
Data type |
Numeric, up to 128 digits. |
Description |
Order reference. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 254 characters that may be restricted for specific payment methods. |
Description |
Text on the customer document. |
|
|
Data |
Value |
Data type |
Alphanumeric with special characters, up to 255 characters. |
Description |
Cleaned order description, which contains only ASCII text. |
|
|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Source order number, if chaining to another order exists. |
Daily closing as a basis
This type is returned in the QUERYBATCHES operation, provided that no error occurred in the operation itself (status=0).
Parameter | Data Type | Description |
---|---|---|
|
Numeric, fixed 9 digits. |
Merchant number. |
|
Numeric |
Daily closing number. |
|
Alphanumeric, up to 32 characters. |
Payment type. |
|
Alphanumeric, up to 255 characters. |
Brand. |
|
Numeric, fixed length of 1. |
Balance state (always |
|
Alphanumeric, up to 16 characters. |
Status of batch ( |
|
Date |
Time of opening. |
|
Alphanumeric, with special characters. |
Number of assigned batch sum objects. |
batch.<n>.merchantNumber |
|
---|---|
Data |
Value |
Data type |
Numeric, fixed 9 digits. |
Description |
Merchant number. |
|
|
Data |
Value |
Data type |
Numeric |
Description |
Daily closing number. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 32 characters. |
Description |
Payment type. |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 255 characters. |
Description |
Brand. |
|
|
Data |
Value |
Data type |
Numeric, fixed length of 1. |
Description |
Balance state (always |
|
|
Data |
Value |
Data type |
Alphanumeric, up to 16 characters. |
Description |
Status of batch ( |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of opening. |
|
|
Data |
Value |
Data type |
Alphanumeric, with special characters. |
Description |
Number of assigned batch sum objects. |
Parameter | Data Type | Description | ||
---|---|---|---|---|
|
Numeric, up to 30. |
Merchant number. Internal account number.
|
||
|
Alphanumeric with up to 9 characters. |
Account-ID. |
||
|
Alphanumeric |
Acquirer |
||
|
Alphanumeric including special characters, up to 255 characters. |
Contract number used with the financial service provider. |
||
|
Alphanumeric including special characters. |
Permitted subsequent operations separated by commas. Empty if no operation is possible. |
||
|
Date |
Time of execution. |
Since the stacks are currency bound, in practice there is a 1:1 connection between stack and stack total. Except for empty stacks, because they have no totals. |
batch.<n>.accountNumber |
|
---|---|
Data |
Value |
Data type |
Numeric, up to 30. |
Description |
Merchant number. Internal account number. |
|
|
Data |
Value |
Data type |
Alphanumeric with up to 9 characters. |
Description |
Account-ID. |
|
|
Data |
Value |
Data type |
Alphanumeric |
Description |
Acquirer |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters, up to 255 characters. |
Description |
Contract number used with the financial service provider. |
|
|
Data |
Value |
Data type |
Alphanumeric including special characters. |
Description |
Permitted subsequent operations separated by commas. Empty if no operation is possible. |
|
|
Data |
Value |
Data type |
Date |
Description |
Time of execution. |
Parameter | Data Type | Description |
---|---|---|
|
Numeric with special characters(dot,comma), up to 20 characters. |
Debit amount of all payments included in this batch total. |
|
Numeric with special characters(dot,comma), up to 20 characters. |
Credit amount of all credits included in this batch total. |
|
Alphabetic or numeric, fixed 3 characters. |
ISO currency code of the objects contained in this batch sum. |
|
Numeric |
Number of payments in this batch total. |
|
Numeric |
Number of credits in this batch total. |
batchTotal.<n>.<m>.totalPaymentAmount |
|
---|---|
Data |
Value |
Data type |
Numeric with special characters(dot,comma), up to 20 characters. |
Description |
Debit amount of all payments included in this batch total. |
|
|
Data |
Value |
Data type |
Numeric with special characters(dot,comma), up to 20 characters. |
Description |
Credit amount of all credits included in this batch total. |
|
|
Data |
Value |
Data type |
Alphabetic or numeric, fixed 3 characters. |
Description |
ISO currency code of the objects contained in this batch sum. |
|
|
Data |
Value |
Data type |
Numeric |
Description |
Number of payments in this batch total. |
|
|
Data |
Value |
Data type |
Numeric |
Description |
Number of credits in this batch total. |
GETINSTALLMENTPLANS
Parameter | Data Type | Description |
---|---|---|
|
Numeric. |
The number of plans included in this response set. |
|
Numeric. |
Gross amount of basket. |
|
Numeric. |
Effective interest per year. |
|
Numeric. |
Effective interest rate overall. |
|
Numeric. |
Amount of the first installment rate. |
|
Numeric. |
Gross installment amount. |
|
Numeric. |
Installment profile number. |
|
Numeric. |
Rate of interest. |
|
Numeric. |
Last installment amount. |
|
Numeric. |
Monthly fee. |
|
Numeric. |
Number of installments. |
|
Numeric. |
Startup fee. |
numberOfPlans |
|
---|---|
Data |
Value |
Data type |
Numeric. |
Description |
The number of plans included in this response set. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Gross amount of basket. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Effective interest per year. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Effective interest rate overall. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Amount of the first installment rate. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Gross installment amount. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Installment profile number. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Rate of interest. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Last installment amount. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Monthly fee. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Number of installments. |
|
|
Data |
Value |
Data type |
Numeric. |
Description |
Startup fee. |