Additional Parameters

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.

Table 1. Optional Consumer Parameters
Parameter Data type Description

CONSUMER_EMAIL

Alphanumeric with special characters, up to 256 characters.

Consumer email address.

CONSUMER_WALLET_ID

Alphanumeric, up to 30 characters.

Account ID of the consumer’s specific wallet system.

CONSUMER_WALLET_TYPE

Alphanumeric, up to 30 characters.

Type/name of the specific wallet system of the consumer.

CONSUMER_BIRTH_DATE

Numeric with special characters, fixed-length 10.

Date of birth of the consumer
Format: YYYY-MM-DD

CONSUMER_TAX_IDENTIFICATION_NUMBER

Alphanumeric with special characters, up to 32 characters.

Tax identification number of the consumer.

CONSUMER_COMPANY_NAME

Alphanumeric with special characters, up to 100 characters.

Company name of the consumer.

CONSUMER_TRADE_REGISTRY_NUMBER

Alphanumeric with special characters, up to 50 characters.

Company register number of the consumer’s company.

CONSUMER_DRIVERS_LICENSE_NUMBER

Alphanumeric with special characters, up to 32 characters.

Consumer’s driver’s license number.

CONSUMER_DRIVERS_LICENSE_COUNTRY

Alphabetic, fixed length of 2 characters.

Country (ISO 3166-1) in which the consumer’s driver’s license was issued.

CONSUMER_DRIVERS_LICENSE_STATE

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]

CONSUMER_LANGUAGE

Alphabetic, fixed 2 characters.

Consumer language.

CONSUMER_DEVICE_ID

Alphanumeric with special characters, up to 4096 characters.

Device ID of the consumer.

Use only explicit instructions!_

CONSUMER_IP_ADDRESS

Alphanumeric, with special characters.

IP address of the consumer.

CONSUMER_MERCHANT_CRM_ID

Alphanumeric, up to 50 characters.

The merchant CRM ID of the consumer.

COMPANY_NAME

Alphanumeric with special characters, up to 100 characters.

Company name of the customer.

COMPANY_VAT_ID

Alphanumeric with special characters, up to 50 characters.

VAT identification number of the customer.

COMPANY_TRADE_REGISTRY_NUMBER

Alphanumeric with special characters, up to 50 characters.

Company register/commercial register number of the customer.

COMPANY_REGISTER_KEY

Alphanumeric with special characters, up to 50 characters.

Other company registration number of the customer.

CONSUMER_AUTHENTICATION_METHOD

Enumeration.

Registration method of the consumer.
Accepted values:

  • 01 = Payment as guest (The consumer is not logged in)

  • 02 = Login with the access data to the customer account in the store

  • 03 = Login with associated ID

  • 04 = Login by credentials of the card issuer

  • 05 = Login by authentication of a third-party provider

  • 06 = Login with FIDO-authenticator.

CONSUMER_AUTHENTICATION_TIMESTAMP

Timestamp.

Time of registration (login) of the consumer in the store.
Format: YYYY-MM-DDT hh:mm:ssZ

If merchant paid as a guest, the time is now.

CONSUMER_CARD_PROVISION_DATE

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).
Format: YYYY-MM-DD

For all other types of checkout (e.g. guest checkout, regular checkout, a first transaction with "one-click checkout"), select today’s date as the value.

CONSUMER_CARD_PROVISION_ATTEMPTS_PAST_DAY

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

CONSUMER_CHALLENGE_INDICATOR

Enumeration.

Indicator whether Strong Customer Authentication (SCA) is required for this transaction.
Accepted values:

  • 01 = No preference

  • 02 = No challenge requested

  • 03 = Challenge requested (3DS Requestor Preference)

  • 04 = Challenge requested (Mandate).

If the element is not provided, the ACS interprets this as 01 = No Preference.

CONSUMER_ACCOUNT_CREATION_DATE

Numeric with special characters, fixed length of 10.

Creation date of the consumer account.
Format: YYYY-MM-DD

Not required if the customer paid as a guest.

CONSUMER_ACCOUNT_PASSWORD_CHANGE_DATE

Numeric with special characters and a fixed length of 10.

Date of the last change of the consumer’s password.
Format: YYYY-MM-DD

Not required if the customer paid as a guest.

CONSUMER_ACCOUNT_PURCHASES_PAST_SIX_MONTHS

Numeric, up to 9 characters.

Number of purchases within the consumer’s last six months.

CONSUMER_SUSPICIOUS_ACTIVITY

Boolean.

Suspicious activities of the consumer
Indicates whether the merchant is aware of any suspicious activity by the consumer (e.g., previous fraud).

CONSUMER_ACCOUNT_TRANSACTIONS_PAST_DAY

Numeric, up to 9 characters.

Number of attempted transactions by the consumer within 24 hours (successful, failed and aborted transactions).
Does not include “merchant-initiated transactions”.

CONSUMER_ACCOUNT_TRANSACTIONS_PAST_YEAR

Numeric, up to 9 characters.

Number of transactions attempted by the consumer within the last year (successful, failed, and aborted transactions).
Does not include “merchant-initiated transactions”.

CONSUMER_ACCOUNT_UPDATE_DATE

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).
Format: YYYY-MM-DD

Not required if the customer paid as a guest.

CONSUMER_DELIVERY_TIMEFRAME

Enumeration.

Time window of delivery.
Accepted values:

  • 01 = Electronic delivery

  • 02 = Same-day delivery

  • 03 = Overnight delivery

  • 04 = Delivery within two days or longer.

CONSUMER_PREORDER_DATE

Numeric with special characters, fixed length of 10.

Date of availability for pre-ordered items.
Format: YYYY-MM-DD

CONSUMER_REORDER_ITEMS

Enumeration.

Reordered item
Indicates whether the consumer reorders previously purchased goods.
Accepted values:

  • 01 = First order

  • 02 = Repeat order.

CONSUMER_RECURRING_FREQUENCY

Alphanumeric, with up to 3 characters.

Number of days between authorizations.

CONSUMER_RECURRING_EXPIRY_DATE

String.

Date after which no more authorizations are to be executed.
Format: YYYY-MM-DD

Table 2. Optional Consumer Parameters
CONSUMER_EMAIL

Data

Value

Data type

Alphanumeric with special characters, up to 256 characters.

Description

Consumer email address.

CONSUMER_WALLET_ID

Data

Value

Data type

Alphanumeric, up to 30 characters.

Description

Account ID of the consumer’s specific wallet system.

CONSUMER_WALLET_TYPE

Data

Value

Data type

Alphanumeric, up to 30 characters.

Description

Type/name of the specific wallet system of the consumer.

CONSUMER_BIRTH_DATE

Data

Value

Data type

Numeric with special characters, fixed-length 10.

Description

Date of birth of the consumer
Format: YYYY-MM-DD

CONSUMER_TAX_IDENTIFICATION_NUMBER

Data

Value

Data type

Alphanumeric with special characters, up to 32 characters.

Description

Tax identification number of the consumer.

CONSUMER_COMPANY_NAME

Data

Value

Data type

Alphanumeric with special characters, up to 100 characters.

Description

Company name of the consumer.

CONSUMER_TRADE_REGISTRY_NUMBER

Data

Value

Data type

Alphanumeric with special characters, up to 50 characters.

Description

Company register number of the consumer’s company.

CONSUMER_DRIVERS_LICENSE_NUMBER

Data

Value

Data type

Alphanumeric with special characters, up to 32 characters.

Description

Consumer’s driver’s license number.

CONSUMER_DRIVERS_LICENSE_COUNTRY

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.

CONSUMER_DRIVERS_LICENSE_STATE

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]

CONSUMER_LANGUAGE

Data

Value

Data type

Alphabetic, fixed 2 characters.

Description

Consumer language.

CONSUMER_DEVICE_ID

Data

Value

Data type

Alphanumeric with special characters, up to 4096 characters.

Description

Device ID of the consumer.

Use only explicit instructions!_

CONSUMER_IP_ADDRESS

Data

Value

Data type

Alphanumeric, with special characters.

Description

IP address of the consumer.

CONSUMER_MERCHANT_CRM_ID

Data

Value

Data type

Alphanumeric, up to 50 characters.

Description

The merchant CRM ID of the consumer.

COMPANY_NAME

Data

Value

Data type

Alphanumeric with special characters, up to 100 characters.

Description

Company name of the customer.

COMPANY_VAT_ID

Data

Value

Data type

Alphanumeric with special characters, up to 50 characters.

Description

VAT identification number of the customer.

COMPANY_TRADE_REGISTRY_NUMBER

Data

Value

Data type

Alphanumeric with special characters, up to 50 characters.

Description

Company register/commercial register number of the customer.

COMPANY_REGISTER_KEY

Data

Value

Data type

Alphanumeric with special characters, up to 50 characters.

Description

Other company registration number of the customer.

CONSUMER_AUTHENTICATION_METHOD

Data

Value

Data type

Enumeration.

Description

Registration method of the consumer.
Accepted values:
- 01 = Payment as guest (The consumer is not logged in)
- 02 = Login with the access data to the customer account in the store,+ - 03 = Login with associated ID
- 04 = Login by credentials of the card issuer
- 05 = Login by authentication of a third-party provider
- 06 = Login with FIDO-authenticator.

CONSUMER_AUTHENTICATION_TIMESTAMP

Data

Value

Data type

Timestamp.

Description

Time of registration (login) of the consumer in the store.
Format: YYYY-MM-DDT hh:mm:ssZ

If merchant paid as a guest, the time is now.

CONSUMER_CARD_PROVISION_DATE

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).
Format: YYYY-MM-DD

For all other types of checkout (e.g. guest checkout, regular checkout, a first transaction with "one-click checkout"), select today’s date as the value.

CONSUMER_CARD_PROVISION_ATTEMPTS_PAST_DAY

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

CONSUMER_CHALLENGE_INDICATOR

Data

Value

Data type

Enumeration.

Description

Indicator whether Strong Customer Authentication (SCA) is required for this transaction.
Accepted values:
- 01 = No preference
- 02 = No challenge requested
- 03 = Challenge requested (3DS Requestor Preference)
- 04 = Challenge requested (Mandate).

NOTE: If the element is not provided, the ACS interprets this as 01 = No Preference.

CONSUMER_ACCOUNT_CREATION_DATE

Data

Value

Data type

Numeric with special characters, fixed length of 10.

Description

Creation date of the consumer account.
Format: YYYY-MM-DD

Not required if the customer paid as a guest.

CONSUMER_ACCOUNT_PASSWORD_CHANGE_DATE

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.
Format: YYYY-MM-DD

Not required if the customer paid as a guest.

CONSUMER_ACCOUNT_PURCHASES_PAST_SIX_MONTHS

Data

Value

Data type

Numeric, up to 9 characters.

Description

Number of purchases within the consumer’s last six months.

CONSUMER_SUSPICIOUS_ACTIVITY

Data

Value

Data type

Boolean.

Description

Suspicious activities of the consumer
Indicates whether the merchant is aware of any suspicious activity by the consumer (e.g., previous fraud).

CONSUMER_ACCOUNT_TRANSACTIONS_PAST_DAY

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).
Does not include “merchant-initiated transactions”.

CONSUMER_ACCOUNT_TRANSACTIONS_PAST_YEAR

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).
Does not include “merchant-initiated transactions”.

CONSUMER_ACCOUNT_UPDATE_DATE

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).
Format: YYYY-MM-DD

Not required if the customer paid as a guest.

CONSUMER_DELIVERY_TIMEFRAME

Data

Value

Data type

Enumeration.

Description

Time window of delivery.
Accepted values:
- 01 = Electronic delivery
- 02 = Same-day delivery
- 03 = Overnight delivery
- 04 = Delivery within two days or longer.

CONSUMER_PREORDER_DATE

Data

Value

Data type

Numeric with special characters, fixed length of 10.

Description

Date of availability for pre-ordered items.
Format: YYYY-MM-DD

CONSUMER_REORDER_ITEMS

Data

Value

Data type

Enumeration.

Description

Reordered item
Indicates whether the consumer reorders previously purchased goods.
Accepted values: - 01 = First order - 02 = Repeat order.

CONSUMER_RECURRING_FREQUENCY

Data

Value

Data type

Alphanumeric, with up to 3 characters.

Description

Number of days between authorizations.

CONSUMER_RECURRING_EXPIRY_DATE

Data

Value

Data type

String.

Description

Date after which no more authorizations are to be executed.
Format: YYYY-MM-DD

Consumer Billing Data

Table 3. Consumer Billing Data Parameters
Parameter Data type Description

CONSUMER_BILLING_FIRST_NAME

First character has to be alphabetic, any other characters ASCII, up to 30 bytes.

Billing address first name.

CONSUMER_BILLING_LAST_NAME

First character has to be alphabetic, any other characters ASCII, up to 30 bytes.

Billing address last name.

CONSUMER_BILLING_ADDRESS_1

Alphanumeric, up to 100 bytes.

Billing address part 1.

CONSUMER_BILLING_ADDRESS_2

Alphanumeric, up to 100 bytes.

Billing address part 2.

CONSUMER_BILLING_ADDRESS_3

Alphanumeric, up to 100 bytes.

Billing address part 3.

CONSUMER_BILLING_CITY

Alphanumeric, up to 32 bytes.

Billing address location.

CONSUMER_BILLING_ZIP_CODE

Alphanumeric, up to 12 characters.

Zip code of the billing address.

CONSUMER_BILLING_STATE

If the CONSUMER_BILLING_COUNTRY is US or CA-Alphabetic, fixed 2 characters and can’t be empty.
For all other country codes-Alphabetic, the max length is 40 characters and there is no minimum length.

State of billing address [1].

CONSUMER_BILLING_COUNTRY

Alphabetic, fixed 2 characters.

Country (ISO 3166-1) of the billing address.

CONSUMER_BILLING_PHONE

Alphanumeric, up to 20 characters.

Billing address phone number.

CONSUMER_BILLING_MOBILE_PHONE

Alphanumeric, up to 18 characters.

Mobile phone number of the billing address.

CONSUMER_BILLING_FAX

Alphanumeric, up to 20 characters.

Billing address fax number.

Table 4. Consumer Billing Data Parameters
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.

CONSUMER_BILLING_LAST_NAME

Data

Value

Data type

First character has to be alphabetic, any other characters ASCII, up to 30 bytes.

Description

Billing address last name.

CONSUMER_BILLING_ADDRESS_1

Data

Value

Data type

Alphanumeric, up to 100 bytes.

Description

Billing address part 1.

CONSUMER_BILLING_ADDRESS_2

Data

Value

Data type

Alphanumeric, up to 100 bytes.

Description

Billing address part 2.

CONSUMER_BILLING_ADDRESS_3

Data

Value

Data type

Alphanumeric, up to 100 bytes.

Description

Billing address part 3.

CONSUMER_BILLING_CITY

Data

Value

Data type

Alphanumeric, up to 32 bytes.

Description

Billing address location.

CONSUMER_BILLING_ZIP_CODE

Data

Value

Data type

Alphanumeric, up to 12 characters.

Description

Zip code of the billing address.

CONSUMER_BILLING_STATE

Data

Value

Data type

If the CONSUMER_BILLING_COUNTRY is US or CA-Alphabetic, fixed 2 characters and can’t be empty.
For all other country codes-Alphabetic, the max length is 40 characters and there is no minimum length.

Description

State of billing address [1].

CONSUMER_BILLING_COUNTRY

Data

Value

Data type

Alphabetic, fixed 2 characters.

Description

Country (ISO 3166-1) of the billing address.

CONSUMER_BILLING_PHONE

Data

Value

Data type

Alphanumeric, up to 20 characters.

Description

Billing address phone number.

CONSUMER_BILLING_MOBILE_PHONE

Data

Value

Data type

Alphanumeric, up to 18 characters.

Description

Mobile phone number of the billing address.

CONSUMER_BILLING_FAX

Data

Value

Data type

Alphanumeric, up to 20 characters.

Description

Billing address fax number.

Consumer Shipping Data

Table 5. Optional Consumer Shipping Data Parameters
Parameter Data type Description

CONSUMER_SHIPPING_FIRST_NAME

First character has to be alphabetic, any other characters ASCII, up to 30 bytes.

First name of the delivery address.

CONSUMER_SHIPPING_LAST_NAME

First character has to be alphabetic, any other characters ASCII, up to 30 bytes.

Last name of the delivery address.

CONSUMER_SHIPPING_ADDRESS_1

Alphanumeric, up to 100 bytes.

Delivery address part 1.

CONSUMER_SHIPPING_ADDRESS_2

Alphanumeric, up to 100 bytes.

Delivery address part 2.

CONSUMER_SHIPPING_CITY

Alphanumeric, up to 32 bytes.

Place of the delivery address.

CONSUMER_SHIPPING_ZIP_CODE

Alphanumeric, up to 12.

Zip code of the delivery address.

CONSUMER_SHIPPING_STATE

If the consumerShippingCountry is US or CA-Alphabetic, fixed 2 characters and can’t be empty.
For all other country codes-Alphabetic, the max length is 40 characters and there is no minimum length.

State of the delivery address [1].

CONSUMER_SHIPPING_COUNTRY

Alphabetic, fixed 2 characters.

Country (ISO 3166-1) of the delivery address.

CONSUMER_SHIPPING_PHONE

Alphanumeric, up to 20.

Delivery address phone number.

CONSUMER_SHIPPING_FAX

Alphanumeric, up to 20.

Fax number of the delivery address.

CONSUMER_SHIPPING_METHOD

Enumeration.

The delivery method is chosen by the consumer.

Use the value that is most appropriate for the delivery method.
Merchants must select a value as an indicator that most accurately describes the consumer’s transaction. For example, if one or more items are included in the sale, use the indicator for the physical goods, or if all goods are digital, use the indicator that describes the most expensive item.

Accepted values:

  • "home_delivery" = shipping to the consumer’s billing address

  • "verified_address_delivery" = shipping to another verified address

  • "other_address_delivery" = shipping to an address that is different from the consumer’s billing address

  • "store_pick_up" = pick up at the local store (business address in shipping address fields)

  • "digital_goods" = Digital goods (including online services, electronic gift cards and redemption codes)

  • "digital_tickets" = Travel and event tickets

  • "other_verified" = Other (e.g., games, digital services, subscriptions).

CONSUMER_SHIPPING_ADDRESS_FIRST_USE_DATE

Numeric with special characters, fixed 10.

Date of the first use of the consumer’s delivery address in the store.
Format: YYYY-MM-DD

Not required if the customer paid as a guest.

CONSUMER_SHIPPING_ITEM_AVAILABILITY

Enumeration.

Availability of the article.
Accepted values:

  • 01 = Currently available

  • 02 = Future availability.

Table 6. Optional Consumer Shipping Data Parameters
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.

CONSUMER_SHIPPING_LAST_NAME

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.

CONSUMER_SHIPPING_ADDRESS_1

Data

Value

Data type

Alphanumeric, up to 100 bytes.

Description

Delivery address part 1.

CONSUMER_SHIPPING_ADDRESS_2

Data

Value

Data type

Alphanumeric, up to 100 bytes.

Description

Delivery address part 2.

CONSUMER_SHIPPING_CITY

Data

Value

Data type

Alphanumeric, up to 32 bytes.

Description

Place of the delivery address.

CONSUMER_SHIPPING_ZIP_CODE

Data

Value

Data type

Alphanumeric, up to 12.

Description

Zip code of the delivery address.

CONSUMER_SHIPPING_STATE

Data

Value

Data type

If the consumerShippingCountry is US or CA-Alphabetic, fixed 2 characters and can’t be empty.
For all other country codes-Alphabetic, the max length is 40 characters and there is no minimum length.

Description

State of the delivery address [1].

CONSUMER_SHIPPING_COUNTRY

Data

Value

Data type

Alphabetic, fixed 2 characters.

Description

Country (ISO 3166-1) of the delivery address.

CONSUMER_SHIPPING_PHONE

Data

Value

Data type

Alphanumeric, up to 20.

Description

Delivery address phone number.

CONSUMER_SHIPPING_FAX

Data

Value

Data type

Alphanumeric, up to 20.

Description

Fax number of the delivery address.

CONSUMER_SHIPPING_METHOD

Data

Value

Data type

Enumeration.

Description

The delivery method is chosen by the consumer.
Use the value that is most appropriate for the delivery method.
Merchants must select a value as an indicator that most accurately describes the consumer’s transaction. For example, if one or more items are included in the sale, use the indicator for the physical goods, or if all goods are digital, use the indicator that describes the most expensive item.
Accepted values:
- "home_delivery" = shipping to the consumer’s billing address
- "verified_address_delivery" = shipping to another verified address
- "other_address_delivery" = shipping to an address that is different from the consumer’s billing address
- "store_pick_up" = pick up at the local store (business address in shipping address fields)
- "digital_goods" = Digital goods (including online services, electronic gift cards and redemption codes)
- "digital_tickets" = Travel and event tickets
- "other_verified" = Other (e.g., games, digital services, subscriptions).

CONSUMER_SHIPPING_ADDRESS_FIRST_USE_DATE

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.
Format: YYYY-MM-DD

Not required if the customer paid as a guest.

CONSUMER_SHIPPING_ITEM_AVAILABILITY

Data

Value

Data type

Enumeration.

Description

Availability of the article.
Accepted values:
- 01 = Currently available
- 02 = Future availability.

Consumer Browser Data

Table 7. Optional Consumer Browser Data Parameters
Parameter Data Type Description

HTTP_HEADERS

Alphanumeric with special, up to 4096 characters.

Number (M) of subsequent HTTP request header elements.

HTTP_HEADER_<m>_NAME

Alphanumeric with special characters, up to 100 characters.

Name of the m-th HTTP request header, where m ∈ {1…​M}.

HTTP_HEADER_<m>_VALUE

Value of the HTTP request header.

Table 8. Optional Consumer Browser Data Parameters
HTTP_HEADERS

Data

Value

Data type

Alphanumeric with special characters, up to 100 characters.

Description

Number (M) of subsequent HTTP request header elements.

HTTP_HEADER_<m>_NAME

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.

Table 9. Optional Basket Item Parameters
Parameter Data Type Description

BASKET_ITEMS

Numeric.

Number (M) of items in the shopping cart.

BASKET_ITEM_<m>_ARTICLE_NUMBER

Alphanumeric with special characters.

Item number of the m-th item, where m ∈ {1…​M}.

BASKET_ITEM_<m>_DESCRIPTION

Alphanumeric with special characters.

Description of the m-th item.

BASKET_ITEM_<m>_IMAGE_URL

Alphanumeric with special characters.

URL to a product image of the m-th item.

BASKET_ITEM_<m>_NAME

Alphanumeric with special characters.

Product name of the m-th item.

BASKET_ITEM_<m>_QUANTITY

Numeric.

Number of m-th item.

BASKET_ITEM_<m>_UNIT_GROSS_AMOUNT

Numeric with special characters(dot,comma), up to 20 characters.

Gross unit price of the m-th single item.

BASKET_ITEM_<m>_UNIT_NET_AMOUNT

Numeric with special characters(dot,comma), up to 20 characters.

Net unit price of the m-th single item.

BASKET_ITEM_<m>_UNIT_TAX_AMOUNT

Numeric with special characters(dot,comma), up to 20 characters.

Tax unit price of the m-th single item.

BASKET_ITEM_<m>_UNIT_TAX_RATE

Numeric with special characters(dot,comma), up to 20 characters.

Tax rate of the m-th item.

Table 10. Optional Basket Item Parameters
BASKET_ITEMS

Data

Value

Data type

Numeric.

Description

Number (M) of items in the shopping cart.

BASKET_ITEM_<m>_ARTICLE_NUMBER

Data

Value

Data type

Alphanumeric with special characters.

Description

Item number of the m-th item, where m ∈ {1…​M}.

BASKET_ITEM_<m>_DESCRIPTION

Data

Value

Data type

Alphanumeric with special characters.

Description

Description of the m-th item.

BASKET_ITEM_<m>_IMAGE_URL

Data

Value

Data type

Alphanumeric with special characters.

Description

URL to a product image of the m-th item.

BASKET_ITEM_<m>_NAME

Data

Value

Data type

Alphanumeric with special characters.

Description

Product name of the m-th item.

BASKET_ITEM_<m>_QUANTITY

Data

Value

Data type

Numeric.

Description

Number of m-th item.

BASKET_ITEM_<m>_UNIT_GROSS_AMOUNT

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Gross unit price of the m-th single item.

BASKET_ITEM_<m>_UNIT_NET_AMOUNT

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Net unit price of the m-th single item.

BASKET_ITEM_<m>_UNIT_TAX_AMOUNT

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Tax unit price of the m-th single item.

BASKET_ITEM_<m>_UNIT_TAX_RATE

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

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.

Table 11. Shopping Basket of the Consumer
Quantity Description Number Price per unit Tax per unit

1

Product A1

A001

EUR 10,80

EUR 1,80

2

Product A2

A002

EUR 14,94

EUR 2,49

3

Shipping

S001

EUR 5,90

EUR 0,0

The parameters for describing the items in the shopping basket of the consumer would be:

Table 12. Parameters for describing the items
Parameter Value Description

BASKET_ITEMS

3

3 different products in the shopping basket

BASKET_ITEM_1_ARTICLE_NUMBER

A001

BASKET_ITEM_1_QUANTITY

1

BASKET_ITEM_1_NAME

Product A1

BASKET_ITEM_1_UNIT_GROSS_AMOUNT

10,80

Gross price per item 1

BASKET_ITEM_1_UNIT_NET_AMOUNT

9,00

Net price per item 1

BASKET_ITEM_1_UNIT_TAX_AMOUNT

1,80

Tax for item 1

BASKET_ITEM_1_UNIT_TAX_RATE

20,000

Tax rate for item 1

BASKET_ITEM_2_ARTICLE_NUMBER

A002

BASKET_ITEM_2_QUANTITY

2

BASKET_ITEM_2_NAME

Product A2

BASKET_ITEM_2_UNIT_GROSS_AMOUNT

14,94

Gross price per item 2

BASKET_ITEM_2_UNIT_NET_AMOUNT

12,45

Net price per item 2

BASKET_ITEM_2_UNIT_TAX_AMOUNT

2,49

Tax for item 2

BASKET_ITEM_2_UNIT_TAX_RATE

20,000

Tax rate for item 2

BASKET_ITEM_3_ARTICLE_NUMBER

S001

BASKET_ITEM_3_QUANTITY

1

BASKET_ITEM_3_NAME

Shipping

BASKET_ITEM_3_UNIT_GROSS_AMOUNT

5,90

Gross price per item 3

BASKET_ITEM_3_UNIT_NET_AMOUNT

5,90

Net price per item 3

BASKET_ITEM_3_UNIT_TAX_AMOUNT

0,0

Tax for item 3

BASKET_ITEM_3_UNIT_TAX_RATE

0,000

Tax rate for item 3

Table 13. Parameters for describing the items
BASKET_ITEMS

Data

3

Description

3 different products in the shopping basket

BASKET_ITEM_1_ARTICLE_NUMBER

Data

A001

Description

BASKET_ITEM_1_QUANTITY

Data

1

Description

BASKET_ITEM_1_NAME

Data

Product A1

Description

BASKET_ITEM_1_UNIT_GROSS_AMOUNT

Data

10,80

Description

Gross price per item 1

BASKET_ITEM_1_UNIT_NET_AMOUNT

Data

9,00

Description

Net price per item 1

BASKET_ITEM_1_UNIT_TAX_AMOUNT

Data

1,80

Description

Tax for item 1

BASKET_ITEM_1_UNIT_TAX_RATE

Data

20,000

Description

Tax rate for item 1

BASKET_ITEM_2_ARTICLE_NUMBER

Data

A002

Description

BASKET_ITEM_2_QUANTITY

Data

2

Description

BASKET_ITEM_2_NAME

Data

Product A2

Description

BASKET_ITEM_2_UNIT_GROSS_AMOUNT

Data

14,94

Description

Gross price per item 2

BASKET_ITEM_2_UNIT_NET_AMOUNT

Data

12,45

Description

Net price per item 2

BASKET_ITEM_2_UNIT_TAX_AMOUNT

Data

2,49

Description

Tax for item 2

BASKET_ITEM_2_UNIT_TAX_RATE

Data

20,000

Description

Tax rate for item 2

BASKET_ITEM_3_ARTICLE_NUMBER

Data

S001

Description

BASKET_ITEM_3_QUANTITY

Data

1

Description

BASKET_ITEM_3_NAME

Data

Shipping

Description

BASKET_ITEM_3_UNIT_GROSS_AMOUNT

Data

5,90

Description

Gross price per item 3

BASKET_ITEM_3_UNIT_NET_AMOUNT

Data

5,90

Description

Net price per item 3

BASKET_ITEM_3_UNIT_TAX_AMOUNT

Data

0,0

Description

Tax for item 3

BASKET_ITEM_3_UNIT_TAX_RATE

Data

0,000

Description

Tax rate for item 3

Browser Parameters

Table 14. Browser Parameters
Parameter Data Type Description

BROWSER_ACCEPT_HEADERS

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.
HTTP Accept header as retrieved from the consumer’s browser in the HTTP request. If the string is longer than 2048, it must be shortened. Specify this field and prevent rejection from the ACS server.

When passed, the ACCEPT_HEADERS parameter is preferred to the BROWSER_ACCEPT_HEADERS parameter (fallback). If the ACCEPT_HEADERS parameter is not sent, the Accept headers are automatically used by the consumer’s browser (by BROWSER_ACCEPT_HEADERS).

BROWSER_CHALLENGE_WINDOW_SIZE

Numeric(2), fixed length 5.

Size of the challenge window.
Dimensions of the challenge window that was displayed to the consumer. The ACS responds with content formatted to render appropriately in this window to provide the best possible user experience. The preconfigured sizes correspond to width x height in pixels of the window displayed in the consumer browser window.
Accepted values:

  • 01 = 250 x 400

  • 02 = 390 x 400

  • 03 = 500 x 600

  • 04 = 600 x 400

  • 05 = full screen.

BROWSER_COLOR_DEPTH

Numeric, up to 2 digits.

Color depth.
The value represents the bit depth of the color palette for displaying images in bits per pixel. Retrieved by the consumer’s browser using the screen.colorDepth property. The field is limited to one and two-digit numbers.
Accepted values:

  • 1 = 1 bit

  • 4 = 4 bits

  • 8 = 8 bits

  • 15 = 15 bits

  • 16 = 16 bits

  • 24 = 24 bits

  • 32 = 32 bits

  • 48 = 48 bits.

BROWSER_JAVA_ENABLED

Boolean.

Java Activation (Boolean yes/no, 1/0).
Indicates whether the consumer browser is capable of running Java. The value is returned by the navigator.javaEnabled property.

BROWSER_LANGUAGE

Alphabetic, up to 8 characters.

Browser language.
Value representing the browser language defined in IETF BCP47. The value is limited to 1-8 characters and is returned by the navigator.language property.

BROWSER_SCREEN_RESOLUTION

Alphabetic, up to 9 characters.

Screen resolution.
Height and width of the screen in pixels. The value is returned by the screen.height and screen.width properties.

BROWSER_TIME_ZONE

Numbers in the range between -720 to 720.

Browser time zone.
The time difference in minutes between UTC and the local time of the consumer’s browser. The value is returned by the getTimezoneOffset() method.

BROWSER_USER_AGENT

Alphanumeric with special characters, up to 128 characters.

User Agent.
User-agent as retrieved from the consumer’s browser in the HTTP request. If the value is more than 256 bytes, it must be shortened. Specify this field and prevent rejection from the ACS server.
When passed, the USER_AGENT parameter is preferred over the "BROWSER_USER_AGENT" parameter (fallback). If the USER_AGENT parameter is not sent, the user agent from the consumer’s browser is automatically used (by "BROWSER_USER_AGENT").

BROWSER_JAVASCRIPT_ENABLED

Boolean.

Javascript Enable (Boolean).
Indicates whether the consumer browser is capable of executing Javascript.

Table 15. Browser Parameters
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.
HTTP Accept header as retrieved from the consumer’s browser in the HTTP request. If the string is longer than 2048, it must be shortened. Specify this field and prevent rejection from the ACS server.
When passed, the ACCEPT_HEADERS parameter is preferred to the BROWSER_ACCEPT_HEADERS parameter (fallback). If the ACCEPT_HEADERS parameter is not sent, the Accept headers are automatically used by the consumer’s browser (by BROWSER_ACCEPT_HEADERS).

BROWSER_CHALLENGE_WINDOW_SIZE

Data

Value

Data type

Numeric(2), fixed length 5.

Description

Size of the challenge window.
Dimensions of the challenge window that was displayed to the consumer. The ACS responds with content formatted to render appropriately in this window to provide the best possible user experience. The preconfigured sizes correspond to width x height in pixels of the window displayed in the consumer browser window.
Accepted values:
- 01 = 250 x 400
- 02 = 390 x 400
- 03 = 500 x 600
- 04 = 600 x 400
- 05 = full screen.

BROWSER_COLOR_DEPTH

Data

Value

Data type

Numeric, up to 2 digits.

Description

Color depth.
The value represents the bit depth of the color palette for displaying images in bits per pixel. Retrieved by the consumer’s browser using the screen.colorDepth property. The field is limited to one and two-digit numbers.
Accepted values:
- 1 = 1 bit
- 4 = 4 bits
- 8 = 8 bits
- 15 = 15 bits
- 16 = 16 bits
- 24 = 24 bits
- 32 = 32 bits
- 48 = 48 bits.

BROWSER_JAVA_ENABLED

Data

Value

Data type

Boolean.

Description

Java Activation (Boolean yes/no, 1/0).
Indicates whether the consumer browser is capable of running Java. The value is returned by the navigator.javaEnabled property.

BROWSER_LANGUAGE

Data

Value

Data type

Alphabetic, up to 8 characters.

Description

Browser language.
Value representing the browser language defined in IETF BCP47. The value is limited to 1-8 characters and is returned by the navigator.language property.

BROWSER_SCREEN_RESOLUTION

Data

Value

Data type

Alphabetic, up to 9 characters.

Description

Screen resolution.
Height and width of the screen in pixels. The value is returned by the screen.height and screen.width properties.

BROWSER_TIME_ZONE

Data

Value

Data type

Numbers in the range between -720 to 720.

Description

Browser time zone.
The time difference in minutes between UTC and the local time of the consumer’s browser. The value is returned by the getTimezoneOffset() method.

BROWSER_USER_AGENT

Data

Value

Data type

Alphanumeric with special characters, up to 128 characters.

Description

User Agent.
User-agent as retrieved from the consumer’s browser in the HTTP request. If the value is more than 256 bytes, it must be shortened. Specify this field and prevent rejection from the ACS server.
When passed, the USER_AGENT parameter is preferred over the "BROWSER_USER_AGENT" parameter (fallback). If the USER_AGENT parameter is not sent, the user agent from the consumer’s browser is automatically used (by "BROWSER_USER_AGENT").

BROWSER_JAVASCRIPT_ENABLED

Data

Value

Data type

Boolean.

Description

Javascript Enable (Boolean).
Indicates whether the consumer browser is capable of executing Javascript.

Recipient Parameters

Table 16. Optional Recipient Parameters
Parameter Data Type Description

RECIPIENT_BIRTH_DATE

Numeric with special characters, fixed-length 10.

Date of birth in the format "dd.MM.yyyy".

RECIPIENT_ACCOUNT

Numeric, up to 19 digits.

Recipient’s credit card number.

RECIPIENT_ZIP_CODE

Alphanumeric, up to 12 characters.

The first 6 digits of the postal code.

RECIPIENT_LAST_NAME

First character has to be alphabetic, any other characters ASCII, up to 30 bytes.

The first 6 digits of the recipient’s last name.

Table 17. Optional Recipient Parameters
RECIPIENT_BIRTH_DATE

Data

Value

Data type

Numeric with special characters, fixed-length 10.

Description

Date of birth in the format "dd.MM.yyyy".

RECIPIENT_ACCOUNT

Data

Value

Data type

Numeric, up to 19 digits

Description

Recipient’s credit card number.

RECIPIENT_ZIP_CODE

Data

Value

Data type

Alphanumeric, up to 12 characters.

Description

The first 6 digits of the postal code.

RECIPIENT_LAST_NAME

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.
Table 18. Required Response Parameters for Orders as a Basic
Parameter Data Type Description

order.<n>.merchantNumber

Numeric, fixed 9 digits.

Merchant number.

order.<n>.orderNumber

Numeric, up to 9 digits.

Order number.

order.<n>.paymentType

Alphanumeric, up to 32 characters.

Payment type.

order.<n>.amount

Numeric with special characters(dot,comma), up to 20 characters.

Amount

order.<n>.brand

Alphanumeric, up to 255 characters.

Brand

order.<n>.currency

Alphabetic or numeric, fixed 3 characters.

ISO currency code

order.<n>.orderDescription

Alphanumeric, up to 255 characters.

Order description

order.<n>.timeCreated

Date

Time of creation,
Format: DD.MM.YYY hh:mm:ss

order.<n>.timeModified

Date

Time of the last change,
Format: DD.MM.YYY hh:mm:ss

order.<n>.state

Alphanumeric, up to 16 characters.

Status of the order (ORDERED, REFUNDABLE, CLOSED).

order.<n>.payments

Numeric

Number of assigned payment objects.

order.<n>.credits

Numeric

Number of assigned credit objects.

Table 19. Required Response Parameters for Orders as a Basic
order.<n>.merchantNumber

Data

Value

Data type

Numeric, fixed 9 digits.

Description

Merchant number.

order.<n>.orderNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Order number.

order.<n>.paymentType

Data

Value

Data type

Alphanumeric, up to 32 characters.

Description

Payment type.

order.<n>.amount

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Amount

order.<n>.brand

Data

Value

Data type

Alphanumeric, up to 255 characters.

Description

Brand

order.<n>.currency

Data

Value

Data type

Alphabetic or numeric, fixed 3 characters.

Description

ISO currency code

order.<n>.orderDescription

Data

Value

Data type

Alphanumeric, up to 255 characters.

Description

Order description

order.<n>.timeCreated

Data

Value

Data type

Date

Description

Time of creation,
Format: DD.MM.YYY hh:mm:ss

order.<n>.timeModified

Data

Value

Data type

Date

Description

Time of the last change,
Format: DD.MM.YYY hh:mm:ss

order.<n>.state

Data

Value

Data type

Alphanumeric, up to 16 characters.

Description

Status of the order (ORDERED, REFUNDABLE, CLOSED). Format: DD.MM.YYY hh:mm:ss

order.<n>.payments

Data

Value

Data type

Numeric

Description

Number of assigned payment objects.

order.<n>.credits

Data

Value

Data type

Numeric

Description

Number of assigned credit objects.

Table 20. Optional Response Parameters for Orders as a Basic
Parameter Data Type Description

order.<n>.acquirer

Alphanumeric

Acquirer

order.<n>.contractNumber

Alphanumeric including special characters, up to 255 characters.

Contract number used with the financial service provider.

order.<n>.operationsAllowed

Alphanumeric including special characters.

Permitted subsequent operations separated by commas. Empty if no operation is possible.

order.<n>.orderReference

Numeric, up to 128 digits.

Order reference.

order.<n>.customerStatement

Alphanumeric, up to 254 characters that may be restricted for specific payment methods.

Text on the customer document.

order.<n>.orderText

Alphanumeric with special characters, up to 255 characters.

Cleaned order description, which contains only ASCII text.

order.<n>.sourceOrderNumber

Numeric, up to 9 digits.

Source order number, if chaining to another order exists.

order.<n>.providerContractNumber

Alphanumeric including special characters, up to 255 characters.

Merchant Account ID (MAID).

Table 21. Optional Response Parameters for Orders as a Basic
order.<n>.acquirer

Data

Value

Data type

Alphanumeric

Description

Acquirer

order.<n>.contractNumber

Data

Value

Data type

Alphanumeric including special characters, up to 255 characters.

Description

Contract number used with the financial service provider.

order.<n>.operationsAllowed

Data

Value

Data type

Alphanumeric including special characters.

Description

Permitted subsequent operations separated by commas. Empty if no operation is possible.

order.<n>.orderReference

Data

Value

Data type

Numeric, up to 128 digits.

Description

Order reference.

order.<n>.customerStatement

Data

Value

Data type

Alphanumeric, up to 254 characters that may be restricted for specific payment methods.

Description

Text on the customer document.

order.<n>.orderText

Data

Value

Data type

Alphanumeric with special characters, up to 255 characters.

Description

Cleaned order description, which contains only ASCII text.

order.<n>.sourceOrderNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Source order number, if chaining to another order exists.

order.<n>.providerContractNumber

Data

Value

Data type

Alphanumeric including special characters, up to 255 characters.

Description

Merchant Account ID (MAID).

Table 22. Required properties of payments <m> belonging to the order <n>
Parameter Data Type Description

payment.<n>.<m>.merchantNumber

Numeric

Merchant number.

payment.<n>.<m>.paymentNumber

Numeric, up to 9 digits.

Payment number.

payment.<n>.<m>.orderNumber

Numeric, up to 9 digits.

Order number.

payment.<n>.<m>.approveAmount

Numeric with special characters(dot,comma), up to 20 characters.

Approved amount of this payment.

payment.<n>.<m>.depositAmount

Numeric with special characters(dot,comma), up to 20 characters.

Deposited amount of this payment.

payment.<n>.<m>.currency

Alphabetic or numeric, fixed 3 characters.

ISO currency code.

payment.<n>.<m>.timeCreated

Date

Time of creation,
Format: DD.MM.YYY hh:mm:ss

payment.<n>.<m>.timeModified

Date

Time of the last change,
Format: DD.MM.YYY hh:mm:ss

payment.<n>.<m>.state

Alphabetic, up to 32 characters.

Status of payment (payment_approved, payment_deposited, payment_closed, payment_approvalexpired;
APPROVED, DEPOSITED, EXPIRED, CLOSED)

payment.<n>.<m>.paymentType

Alphanumeric, up to 64 characters.

Payment type

Table 23. Required properties of payments <m> belonging to the order <n>
payment.<n>.<m>.merchantNumber

Data

Value

Data type

Numeric

Description

Merchant number.

payment.<n>.<m>.paymentNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Payment number.

payment.<n>.<m>.orderNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Order number.

payment.<n>.<m>.approveAmount

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Approved amount of this payment.

payment.<n>.<m>.depositAmount

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Deposited amount of this payment.

payment.<n>.<m>.currency

Data

Value

Data type

Alphabetic or numeric, fixed 3 characters.

Description

ISO currency code.

payment.<n>.<m>.timeCreated

Data

Value

Data type

Date

Description

Time of creation,
Format: DD.MM.YYY hh:mm:ss

payment.<n>.<m>.timeModified

Data

Value

Data type

Date

Description

Time of the last change,
Format: DD.MM.YYY hh:mm:ss

payment.<n>.<m>.state

Data

Value

Data type

Alphabetic, up to 32 characters.

Description

Status of payment (payment_approved, payment_deposited, payment_closed, payment_approvalexpired;
APPROVED, DEPOSITED, EXPIRED, CLOSED)

payment.<n>.<m>.paymentType

Data

Value

Data type

Alphanumeric, up to 64 characters.

Description

Payment type

Table 24. Optional properties of payments <m> belonging to the order <n>
Parameter Data Type Description

payment.<n>.<m>.approvalCode

Alphanumeric

Approval code from the financial service provider can also be empty.

payment.<n>.<m>.batchNumber

Numeric, up to 9 digits.

Only included if payment is already assigned to a daily closing (= deposited).

payment.<n>.<m>.operationsAllowed

Alphanumeric including special characters.

Permitted subsequent operations separated by commas.
Empty if no operations are possible.

payment.<n>.<m>.gatewayReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Reference number of the respective payment gateway/financial service provider (does not have to be numeric).

payment.<n>.<m>.merchantReference

ASCII up to 128 characters, but may differ for specific payment methods.

Merchant reference of the booking.
Only used with deposit. If it’s not sent with a deposit, the orderReference is used instead.

payment.<n>.<m>.instrumentCountry

Alphabetic, fixed 2 characters.

Country code country of issue of the means of payment.

payment.<n>.<m>.providerReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Provider reference for booking.

Table 25. Optional properties of payments <m> belonging to the order <n>
payment.<n>.<m>.approvalCode

Data

Value

Data type

Alphanumeric

Description

Approval code from the financial service provider can also be empty.

payment.<n>.<m>.batchNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Only included if payment is already assigned to a daily closing (= deposited).

payment.<n>.<m>.operationsAllowed

Data

Value

Data type

Alphanumeric including special characters.

Description

Permitted subsequent operations separated by commas.
Empty if no operations are possible.

payment.<n>.<m>.gatewayReferenceNumber

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

payment.<n>.<m>.merchantReference

Data

Value

Data type

ASCII up to 128 characters, but may differ for specific payment methods.

Description

Merchant reference of the booking.
Only used with deposit. If it’s not sent with a deposit, the orderReference is used instead.

payment.<n>.<m>.instrumentCountry

Data

Value

Data type

Alphabetic, fixed 2 characters.

Description

Country code country of issue of the means of payment.

payment.<n>.<m>.providerReferenceNumber

Data

Value

Data type

Alphanumeric including special characters, up to 255 characters.

Description

Provider reference for booking.

Table 26. Optional Response Additional Parameters for EPS
Parameter Data Type Description

payment.<n>.<m>.epsConsumerName

Alphanumeric with special characters, up to 255.

Consumer name.

payment.<n>.<m>.epsConsumerBIC

Alphanumeric, up to 50.

BIC of the customer.

payment.<n>.<m>.epsConsumerIBAN

Alphanumeric, up to 50.

IBAN of the customer.

Table 27. Optional Response Additional Parameters for EPS
payment.<n>.<m>.epsConsumerName

Data

Value

Data type

Alphanumeric with special characters, up to 255.

Description

Consumer name.

payment.<n>.<m>.epsConsumerBIC

Data

Value

Data type

Alphanumeric, up to 50.

Description

BIC of the customer.

payment.<n>.<m>.epsConsumerIBAN

Data

Value

Data type

Alphanumeric, up to 50.

Description

IBAN of the customer.

Table 28. Optional Response Additional Parameters for Paypal
Parameter Data Type Description

payment.<n>.<m>.paypalPayerID

Alphanumeric, up to 13 characters.

ID of the PayPal consumer.

payment.<n>.<m>.paypalPayerEmail

Alphanumeric including special characters, up to 127 characters.

PayPal consumer email.

payment.<n>.<m>.paypalPayerFirstName

Alphanumeric, up to 64 characters.

PayPal consumer first name.

payment.<n>.<m>.paypalPayerLastName

Alphanumeric, up to 64 characters.

Last name of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressCountry

Alphabetic, up to 50 characters.

Country of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressCountryCode

Alphabetic, fixed 2 characters.

Country (ISO 3166-1) of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressCity

Alphabetic, up to 40 characters.

PayPal consumer city.

payment.<n>.<m>.paypalPayerAddressState

Alphabetic, fixed 2 characters.

State of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressName

Alphanumeric, up to 100 characters.

Address name of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressStreet1

Alphanumeric, up to 100 characters.

Street (1) of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressStreet2

Alphanumeric, up to 100 characters.

Street (2) of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressZIP

Alphanumeric, up to 32 characters.

Zip code of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressStatus

Alphanumeric, up to 32 characters.

Status of the address verification of the PayPal consumer.

payment.<n>.<m>.paypalProtectionEligibility

Alphanumeric, up to 32 characters.

Seller protection information.

payment.<n>.<m>.paypalBillingAgreementID

Alphanumeric including special characters, up to 19 characters.

Billing agreement ID created by PayPal which can be used for recurring payments.

Table 29. Optional Response Additional Parameters for Paypal
payment.<n>.<m>.paypalPayerID

Data

Value

Data type

Alphanumeric, up to 13 characters.

Description

ID of the PayPal consumer.

payment.<n>.<m>.paypalPayerEmail

Data

Value

Data type

Alphanumeric including special characters, up to 127 characters.

Description

PayPal consumer email.

payment.<n>.<m>.paypalPayerFirstName

Data

Value

Data type

Alphanumeric, up to 64 characters.

Description

PayPal consumer first name.

payment.<n>.<m>.paypalPayerLastName

Data

Value

Data type

Alphanumeric, up to 64 characters.

Description

Last name of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressCountry

Data

Value

Data type

Alphabetic, up to 50 characters.

Description

Country of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressCountryCode

Data

Value

Data type

Alphabetic, fixed 2 characters.

Description

Country (ISO 3166-1) of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressCity

Data

Value

Data type

Alphabetic, up to 40 characters.

Description

PayPal consumer city.

payment.<n>.<m>.paypalPayerAddressState

Data

Value

Data type

Alphabetic, fixed 2 characters.

Description

State of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressName

Data

Value

Data type

Alphanumeric, up to 100 characters.

Description

Address name of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressStreet1

Data

Value

Data type

Alphanumeric, up to 100 characters.

Description

Street (1) of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressStreet2

Data

Value

Data type

Alphanumeric, up to 100 characters.

Description

Street (2) of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressZIP

Data

Value

Data type

Alphanumeric, up to 32 characters.

Description

Zip code of the PayPal consumer.

payment.<n>.<m>.paypalPayerAddressStatus

Data

Value

Data type

Alphanumeric, up to 32 characters.

Description

Status of the address verification of the PayPal consumer.

payment.<n>.<m>.paypalProtectionEligibility

Data

Value

Data type

Alphanumeric, up to 32 characters.

Description

Seller protection information.

payment.<n>.<m>.paypalBillingAgreementID

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.

Table 30. Required Response Additional Parameters for Sofort
Parameter Data Type Description

payment.<n>.<m>.senderAccountOwner

Alphanumeric including special characters, up to 255 characters.

Name of the sender account.

payment.<n>.<m>.senderAccountNumber

Alphanumeric including special characters, up to 255 characters.

Sender’s account number.

payment.<n>.<m>.senderBankNumber

Numeric, up to 30 digits.

Sender bank code.

payment.<n>.<m>.senderBankName

Numeric, up to 30 digits.

Name of the sender’s bank.

payment.<n>.<m>.senderCountry

Alphabetic, fixed 2 characters.

Country of the sender account.

Table 31. Required Response Additional Parameters for Sofort
payment.<n>.<m>.senderAccountOwner

Data

Value

Data type

Alphanumeric including special characters, up to 255 characters.

Description

Name of the sender account.

payment.<n>.<m>.senderAccountNumber

Data

Value

Data type

Alphanumeric including special characters, up to 255 characters.

Description

Sender’s account number.

payment.<n>.<m>.senderBankNumber

Data

Value

Data type

Numeric, up to 30 digits.

Description

Sender bank code.

payment.<n>.<m>.senderBankName

Data

Value

Data type

Numeric, up to 30 digits.

Description

Name of the sender’s bank.

payment.<n>.<m>.senderCountry

Data

Value

Data type

Alphabetic, fixed 2 characters.

Description

Country of the sender account.

Table 32. Optional Response Additional Parameters for Sofort
Parameter Data Type Description

payment.<n>.<m>.senderBIC

Alphanumeric, up to 50 characters.

BIC of the sender account.

payment.<n>.<m>.senderIBAN

Alphanumeric, up to 50 characters.

IBAN of the sender account.

payment.<n>.<m>.securityCriteria

Numeric with a fixed length of 1 digit.

Safety criterion met.

Table 33. Optional Response Additional Parameters for Sofort
payment.<n>.<m>.senderBIC

Data

Value

Data type

Alphanumeric, up to 50 characters.

Description

BIC of the sender account.

payment.<n>.<m>.senderIBAN

Data

Value

Data type

Alphanumeric, up to 50 characters.

Description

IBAN of the sender account.

payment.<n>.<m>.securityCriteria

Data

Value

Data type

Numeric with a fixed length of 1 digit.

Description

Safety criterion met.

Table 34. Optional Response Additional Parameters for SEPA
Parameter Data Type Description

payment.<n>.<m>.mandateID

Alphanumeric, up to 35 characters.

Mandate reference used.

payment.<n>.<m>.mandateSignatureDate

Date as DD.MM.YYYY

Mandate signature date.

payment.<n>.<m>.dueDate

Date as DD.MM.YYYY

Planned date of execution of the direct debit.

payment.<n>.<m>.creditorID

Alphanumeric, up to 35.

Merchant identifier used.

Table 35. Optional Response Additional Parameters for SEPA
payment.<n>.<m>.mandateID

Data

Value

Data type

Alphanumeric, up to 35 characters.

Description

Mandate reference used.

payment.<n>.<m>.mandateSignatureDate

Data

Value

Data type

Alphanumeric, up to 35 characters.

Description

Mandate signature date.

payment.<n>.<m>.dueDate

Data

Value

Data type

Date as DD.MM.YYYY

Description

Merchant identifier used.

Table 36. Required properties of the credit notes <m> belonging to the order <n>.
Parameter Data Type Description

credit.<n>.<m>.merchantNumber

Numeric

Merchant number.

credit.<n>.<m>.creditNumber

Numeric, up to 9 digits.

Credit note number.

credit.<n>.<m>.orderNumber

Numeric, up to 9 digits.

Order number.

credit.<n>.<m>.batchNumber

Numeric, up to 9 digits.

Associated daily closing number.

credit.<n>.<m>.amount

Numeric with special characters(dot,comma), up to 20 characters.

Amount of the credit note.

credit.<n>.<m>.currency

Alphabetic or numeric, fixed 3 characters.

ISO currency code.

credit.<n>.<m>.timeCreated

Date

Time of creation,
Format: DD.MM.YYY hh:mm:ss

credit.<n>.<m>.timeModified

Date

Time of modification,
Format: DD.MM.YYY hh:mm:ss

credit.<n>.<m>.state

Alphabetic including special characters.

Status of credit note (credit_refunded, credit_closed).

Table 37. Required properties of the credit notes <m> belonging to the order <n>.
credit.<n>.<m>.merchantNumber

Data

Value

Data type

Numeric

Description

Merchant number.

credit.<n>.<m>.creditNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Credit note number.

credit.<n>.<m>.orderNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Order number.

credit.<n>.<m>.batchNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Associated daily closing number.

credit.<n>.<m>.amount

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Amount of the credit note.

credit.<n>.<m>.currency

Data

Value

Data type

Alphabetic or numeric, fixed 3 characters.

Description

ISO currency code.

credit.<n>.<m>.timeCreated

Data

Value

Data type

Date

Description

Time of creation,
Format: DD.MM.YYY hh:mm:ss

credit.<n>.<m>.timeModified

Data

Value

Data type

Date

Description

Time of modification,
Format: DD.MM.YYY hh:mm:ss

credit.<n>.<m>.state

Data

Value

Data type

Alphabetic including special characters.

Description

Status of credit note (credit_refunded, credit_closed).

Table 38. Optional properties of the credit notes <m> belonging to the order <n>.
Parameter Data Type Description

credit.<n>.<m>.operationsAllowed

Alphanumeric including special characters.

Permitted subsequent operations separated by commas. Empty if no operations are possible.

credit.<n>.<m>.gatewayReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Reference number of the respective payment gateway/financial service provider (does not have to be numeric).

credit.<n>.<m>.merchantReference

ASCII up to 128 characters, but may differ for specific payment methods.

Merchant reference of the credit note.

credit.<n>.<m>.providerReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Provider reference of the credit note.

Table 39. Optional properties of the credit notes <m> belonging to the order <n>.
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.

credit.<n>.<m>.gatewayReferenceNumber

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

credit.<n>.<m>.merchantReference

Data

Value

Data type

ASCII up to 128 characters, but may differ for specific payment methods.

Description

Merchant reference of the credit note.

credit.<n>.<m>.providerReferenceNumber

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

Table 40. Required Response Parameters for Credit Notes as a Basis
Parameter Data Type Description

credit.<n>.merchantNumber

Numeric

Merchant number.

credit.<n>.creditNumber

Numeric, up to 9 digits.

Credit note number.

credit.<n>.orderNumber

Numeric, up to 9 digits.

Order number.

credit.<n>.batchNumber

Numeric, up to 9 digits.

Associated daily closing number.

credit.<n>.amount

Numeric with special characters(dot,comma), up to 20 characters.

Amount of the credit note.

credit.<n>.currency

Alphabetic or numeric, fixed 3 characters.

ISO currency code.

credit.<n>.timeCreated

Date

Time of creation,
Format: DD.MM.YYY hh:mm:ss

credit.<n>.timeModified

Date

Time of modification,
Format: DD.MM.YYY hh:mm:ss

credit.<n>.state

Alphabetic including special characters.

Status of credit note (credit_refunded, credit_closed).

Table 41. Required Response Parameters for Credit Notes as a Basis
credit.<n>.merchantNumber

Data

Value

Data type

Numeric

Description

Merchant number.

credit.<n>.creditNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Credit note number.

credit.<n>.orderNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Order number.

credit.<n>.batchNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Associated daily closing number.

credit.<n>.amount

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Amount of the credit note.

credit.<n>.currency

Data

Value

Data type

Alphabetic or numeric, fixed 3 characters.

Description

ISO currency code.

credit.<n>.timeCreated

Data

Value

Data type

Date

Description

Time of creation,
Format: DD.MM.YYY hh:mm:ss

credit.<n>.timeModified

Data

Value

Data type

Date

Description

Time of modification,
Format: DD.MM.YYY hh:mm:ss

credit.<n>.state

Data

Value

Data type

Alphabetic including special characters.

Description

Status of credit note (credit_refunded, credit_closed).

Table 42. Optional Response Parameters for Credit Notes as a Basis
Parameter Data Type Description

credit.<n>.operationsAllowed

Alphanumeric including special characters.

Permitted subsequent operations separated by commas. Empty if no operations are possible.

credit.<n>.gatewayReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Reference number of the respective payment gateway/financial service provider (does not have to be numeric).

credit.<n>.merchantReference

ASCII up to 128 characters, but may differ for specific payment methods.

Merchant reference of the credit note.

Table 43. Optional Response Parameters for Credit Notes as a Basis
credit.<n>.operationsAllowed

Data

Value

Data type

Alphanumeric including special characters.

Description

Permitted subsequent operations separated by commas. Empty if no operations are possible.

credit.<n>.gatewayReferenceNumber

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

credit.<n>.merchantReference

Data

Value

Data type

ASCII up to 128 characters, but may differ for specific payment methods.

Description

Merchant reference of the credit note.

Table 44. Required response parameters of the order <1> belonging to the credit note <n>.
Parameter Data Type Description

order.<n>.1.merchantNumber

Numeric, fixed 9 digits.

Merchant number.

order.<n>.1.orderNumber

Numeric, up to 9 digits.

Order number.

order.<n>.1.paymentType

Alphanumeric, up to 32 characters.

Payment type.

order.<n>.1.amount

Numeric with special characters(dot,comma), up to 20 characters.

Amount.

order.<n>.1.brand

Alphanumeric, up to 255 characters.

Brand

order.<n>.1.currency

Alphabetic or numeric, fixed 3 characters.

ISO currency code.

order.<n>.1.orderDescription

Alphanumeric, up to 255 characters.

Order description

order.<n>.1.timeCreated

Date

Time of creation,
Format: DD.MM.YYY hh:mm:ss

order.<n>.1.timeModified

Date

Time of the last change,
Format: DD.MM.YYY hh:mm:ss

order.<n>.1.state

Alphanumeric, up to 16 characters.

Status of the order (ORDERED, REFUNDABLE, CLOSED)

Table 45. Required response parameters of the order <1> belonging to the credit note <n>.
order.<n>.1.merchantNumber

Data

Value

Data type

Numeric, fixed 9 digits.

Description

Merchant number.

order.<n>.1.orderNumber

Data

Value

Data type

Numeric, up to 9 digits.

Description

Order number.

order.<n>.1.paymentType

Data

Value

Data type

Alphanumeric, up to 32 characters.

Description

Payment type.

order.<n>.1.amount

Data

Value

Data type

Numeric with special characters(dot,comma), up to 20 characters.

Description

Amount.

order.<n>.1.brand

Data

Value

Data type

Alphanumeric, up to 255 characters.

Description

Brand

order.<n>.1.currency

Data

Value

Data type

Alphabetic or numeric, fixed 3 characters.

Description

ISO currency code.

order.<n>.1.orderDescription

Data

Value

Data type

Alphanumeric, up to 255 characters.

Description

Order description

order.<n>.1.timeCreated

Data

Value

Data type

Date

Description

Time of creation,
Format: DD.MM.YYY hh:mm:ss

order.<n>.1.timeModified

Data

Value

Data type

Date

Description

Time of the last change,
Format: DD.MM.YYY hh:mm:ss

order.<n>.1.state

Data

Value

Data type

Alphanumeric, up to 16 characters.

Description

Status of the order (ORDERED, REFUNDABLE, CLOSED)

Table 46. Optional response parameters of the order <1> belonging to the credit note <n>.
Parameter Data Type Description

order.<n>.1.acquirer

Alphanumeric

Acquirer.

order.<n>.1.contractNumber

Alphanumeric including special characters, up to 255 characters.

Contract number used with the financial service provider.

order.<n>.1.operationsAllowed

Alphanumeric including special characters.

Permitted subsequent operations separated by commas. Empty if no operation is possible.

order.<n>.1.orderReference

Numeric, up to 128 digits.

Order reference.

order.<n>.1.customerStatement

Alphanumeric, up to 254 characters that may be restricted for specific payment methods.

Text on the customer document.

order.<n>.1.orderText

Alphanumeric with special characters, up to 255 characters.

Cleaned order description, which contains only ASCII text.

order.<n>.1.sourceOrderNumber

Numeric, up to 9 digits.

Source order number, if chaining to another order exists.

Table 47. Optional response parameters of the order <1> belonging to the credit note <n>.
order.<n>.1.acquirer

Data

Value

Data type

Alphanumeric

Description

Acquirer.

order.<n>.1.contractNumber

Data

Value

Data type

Alphanumeric including special characters, up to 255 characters.

Description

Contract number used with the financial service provider.

order.<n>.1.operationsAllowed

Data

Value

Data type

Alphanumeric including special characters.

Description

Permitted subsequent operations separated by commas. Empty if no operation is possible.

order.<n>.1.orderReference

Data

Value

Data type

Numeric, up to 128 digits.

Description

Order reference.

order.<n>.1.customerStatement

Data

Value

Data type

Alphanumeric, up to 254 characters that may be restricted for specific payment methods.

Description

Text on the customer document.

order.<n>.1.orderText

Data

Value

Data type

Alphanumeric with special characters, up to 255 characters.

Description

Cleaned order description, which contains only ASCII text.

order.<n>.1.sourceOrderNumber

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

Table 48. Required response parameters for daily closing as a basis
Parameter Data Type Description

batch.<n>.merchantNumber

Numeric, fixed 9 digits.

Merchant number.

batch.<n>.batchNumber

Numeric

Daily closing number.

batch.<n>.paymentType

Alphanumeric, up to 32 characters.

Payment type.

batch.<n>.brand

Alphanumeric, up to 255 characters.

Brand.

batch.<n>.status

Numeric, fixed length of 1.

Balance state (always balanced).

batch.<n>.state

Alphanumeric, up to 16 characters.

Status of batch (open, closed).

batch.<n>.timeOpened

Date

Time of opening.
Format: DD.MM.YYY hh:mm:ss

batch.<n>.batchTotals

Alphanumeric, with special characters.

Number of assigned batch sum objects.

Table 49. Required response parameters for daily closing as a basis
batch.<n>.merchantNumber

Data

Value

Data type

Numeric, fixed 9 digits.

Description

Merchant number.

batch.<n>.batchNumber

Data

Value

Data type

Numeric

Description

Daily closing number.

batch.<n>.paymentType

Data

Value

Data type

Alphanumeric, up to 32 characters.

Description

Payment type.

batch.<n>.brand

Data

Value

Data type

Alphanumeric, up to 255 characters.

Description

Brand.

batch.<n>.status

Data

Value

Data type

Numeric, fixed length of 1.

Description

Balance state (always balanced).

batch.<n>.state

Data

Value

Data type

Alphanumeric, up to 16 characters.

Description

Status of batch (open, closed).

batch.<n>.timeOpened

Data

Value

Data type

Date

Description

Time of opening.
Format: DD.MM.YYY hh:mm:ss

batch.<n>.batchTotals

Data

Value

Data type

Alphanumeric, with special characters.

Description

Number of assigned batch sum objects.

Table 50. Optional Response Parameters for Daily Closing as a Basis
Parameter Data Type Description

batch.<n>.accountNumber

Numeric, up to 30.

Merchant number. Internal account number.

Only available for backward compatibility reasons. Should not be used in new implementations! New implementations should only use the account ID.

batch.<n>.accountID

Alphanumeric with up to 9 characters.

Account-ID.

batch.<n>.acquirer

Alphanumeric

Acquirer

batch.<n>.contractNumber

Alphanumeric including special characters, up to 255 characters.

Contract number used with the financial service provider.

batch.<n>.operationsAllowed

Alphanumeric including special characters.

Permitted subsequent operations separated by commas. Empty if no operation is possible.

batch.<n>.timeClosed

Date

Time of execution.
Format: DD.MM.YYY hh:mm:ss

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.
Table 51. Optional Response Parameters for Daily Closing as a Basis
batch.<n>.accountNumber

Data

Value

Data type

Numeric, up to 30.

Description

Merchant number. Internal account number.
Only available for backward compatibility reasons. Should not be used in new implementations! New implementations should only use the account ID.

batch.<n>.accountID

Data

Value

Data type

Alphanumeric with up to 9 characters.

Description

Account-ID.

batch.<n>.acquirer

Data

Value

Data type

Alphanumeric

Description

Acquirer

batch.<n>.contractNumber

Data

Value

Data type

Alphanumeric including special characters, up to 255 characters.

Description

Contract number used with the financial service provider.

batch.<n>.operationsAllowed

Data

Value

Data type

Alphanumeric including special characters.

Description

Permitted subsequent operations separated by commas. Empty if no operation is possible.

batch.<n>.timeClosed

Data

Value

Data type

Date

Description

Time of execution.
Format: DD.MM.YYY hh:mm:ss

Table 52. Required response parameters of the stack sums <n> belonging to the stack <m>
Parameter Data Type Description

batchTotal.<n>.<m>.totalPaymentAmount

Numeric with special characters(dot,comma), up to 20 characters.

Debit amount of all payments included in this batch total.

batchTotal.<n>.<m>.totalCreditAmount

Numeric with special characters(dot,comma), up to 20 characters.

Credit amount of all credits included in this batch total.

batchTotal.<n>.<m>.currency

Alphabetic or numeric, fixed 3 characters.

ISO currency code of the objects contained in this batch sum.

batchTotal.<n>.<m>.payments

Numeric

Number of payments in this batch total.

batchTotal.<n>.<m>.credits

Numeric

Number of credits in this batch total.

Table 53. Required response parameters of the stack sums <n> belonging to the stack <m>
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.

batchTotal.<n>.<m>.totalCreditAmount

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.

batchTotal.<n>.<m>.currency

Data

Value

Data type

Alphabetic or numeric, fixed 3 characters.

Description

ISO currency code of the objects contained in this batch sum.

batchTotal.<n>.<m>.payments

Data

Value

Data type

Numeric

Description

Number of payments in this batch total.

batchTotal.<n>.<m>.credits

Data

Value

Data type

Numeric

Description

Number of credits in this batch total.

GETINSTALLMENTPLANS

Table 54. Optional response parameters for getting installment plans
Parameter Data Type Description

numberOfPlans

Numeric.

The number of plans included in this response set.

plan.<n>.basketAmount

Numeric.

Gross amount of basket.

plan.<n>.effectiveAnnualPercentageRate

Numeric.

Effective interest per year.

plan.<n>.effectiveInterestRate

Numeric.

Effective interest rate overall.

plan.<n>.firstInstallmentAmount

Numeric.

Amount of the first installment rate.

plan.<n>.installmentAmount

Numeric.

Gross installment amount.

plan.<n>.installmentProfileNumber

Numeric.

Installment profile number.

plan.<n>.interestRate

Numeric.

Rate of interest.

plan.<n>.lastInstallmentAmount

Numeric.

Last installment amount.

plan.<n>.monthlyFee

Numeric.

Monthly fee.

plan.<n>.numberOfInstallments

Numeric.

Number of installments.

plan.<n>.startupFee

Numeric.

Startup fee.

Table 55. Optional response parameters for getting installment plans
numberOfPlans

Data

Value

Data type

Numeric.

Description

The number of plans included in this response set.

plan.<n>.basketAmount

Data

Value

Data type

Numeric.

Description

Gross amount of basket.

plan.<n>.effectiveAnnualPercentageRate

Data

Value

Data type

Numeric.

Description

Effective interest per year.

plan.<n>.effectiveInterestRate

Data

Value

Data type

Numeric.

Description

Effective interest rate overall.

plan.<n>.firstInstallmentAmount

Data

Value

Data type

Numeric.

Description

Amount of the first installment rate.

plan.<n>.installmentAmount

Data

Value

Data type

Numeric.

Description

Gross installment amount.

plan.<n>.installmentProfileNumber

Data

Value

Data type

Numeric.

Description

Installment profile number.

plan.<n>.interestRate

Data

Value

Data type

Numeric.

Description

Rate of interest.

plan.<n>.lastInstallmentAmount

Data

Value

Data type

Numeric.

Description

Last installment amount.

plan.<n>.monthlyFee

Data

Value

Data type

Numeric.

Description

Monthly fee.

plan.<n>.numberOfInstallments

Data

Value

Data type

Numeric.

Description

Number of installments.

plan.<n>.startupFee

Data

Value

Data type

Numeric.

Description

Startup fee.


1. For United States of America (USA) and Canada as an abbreviation, otherwise written out in full.
2. For United States of America (USA) and Canada as an abbreviation, otherwise written out in full.