Field Definitions

Name

The field name structure is based on the hierarchical relation between individual elements.
Example: order-items.order-item.article-number

XML Structure
<payment>
    <order-items>
        <order-item>
            <article-number> </article-number>
        </order-item>
    </order-items>
</payment>

In the example, the parent element is order-items, and its child order-item.
order-item itself is also a parent element of its child article-number. The hierarchies are separated by a dot .

Cardinality

Cardinality indicates if the field is necessary for the request to work. A field can be either mandatory (M) or optional (O).

  • If a field is mandatory, it must be included in all credit card requests and contain a value. Without this field, credit card requests fail.

  • If a field is optional, it can, but does not have to be, included in all credit card requests. Including optional fields can have certain advantages. These are included in the respective field description.

Some fields can be mandatory for individual requests, depending on transaction type and payment scenario. We list them as M/O. See the field description for more information on the respective field’s cardinality.

Example:merchant-account-id is listed as M/O.

Some transactions require a merchant-account-id, others a merchant-account-resolver-category. These two fields shall be used complementary, depending on the context which is explained in the description field.

Data Types

Data types define the input values that can be used for a field.

Data Type Description

String

A combination of text and numbers which is arbitrary but finite in size. A subset of String values can be defined according to a pattern value, such as api-id. The pattern is given in the Description column.

Enumeration

A subset of String. Enumeration consists of a list of predefined values, e.g. the severity of a status, which can provide the predefined values warning, error and information.

Boolean

Has one of two possible values (usually either true or false).

Date

Value taken from a calendar (e.g. the date of birth).
Format (according to ISO 8601): YYYY-MM-DD
This pattern cannot be customized.

Timestamp

A moment in time defined by a system.
Format (according to ISO 8601): YYYY-MM-DDThh:mm:ssZ
This pattern cannot be customized.

Decimal

A numeric value which has digits before and after the decimal point .
Example: the amount of money in a specific currency (e.g. 138.53 EUR).

Number

A numeric value that has no decimal places, such as the expiration month of a credit card.

Size

Size shows how many characters can be used for this field. We provide the maximum value so you can make sure the whole amount of characters is processed.

In general, the Wirecard Payment Gateway allows all characters for each field, depending on the Data Type.

If other rules apply to a field, they are stated in the Description column.

Custom URL: