Fields

Credit Card Request

Field Cardinality Datatype Size Description

merchant_account_id

M

Alphanumeric

36

Account ID of the merchant.

request_id

M

Alphanumeric

150

Unique request ID for each Transaction (= Merchant Transaction ID).

payment_method_id

M

Alphanumeric

15

Payment method.

Only SEPA DD, SEPA CT and Credit Card are allowed.

transaction_type

M

Alphanumeric

30

Transaction type (direct relationship to payment method).

parent_transaction_id

O

Alphanumeric

36

Transaction ID of authorization or parent transaction, if either transaction is available and should be referred to.

requested_amount

O

Numeric

15

Amount in decimal number. Max length = total number of digits.

The number of digits after the decimal point depends on the currency. Example: 100.000 INR (Indian Rupee) but 100.00 EUR

requested_amount_currency

O

Alphanumeric

3

Currency.

account_number

O

Alphanumeric

36

This is the card account number of the end consumer. It is mandatory if card-token is not used.

iban

Empty

Alphanumeric

0

"Provide empty value" for this field by using the construct ,,.

bic

Empty

Alphanumeric

0

"Provide empty value" for this field by using the construct ,,.

token_id

O

Alphanumeric

36

This is the token corresponding to account_number of the end consumer. It is mandatory if account_number is not specified. It is unique per instance.

card_type

O

See Card Types defined in API

15

This is the consumer’s card type.

expiration_month

O

Numeric

2

This is the expiration month of the consumer’s credit card.

expiration_year

O

Numeric

2

This is the expiration year of the consumer’s credit card.

first_name

O

Alphanumeric

32

First name of consumer.

last_name

O

Alphanumeric

32

Last name of consumer.

email

O

Alphanumeric

64

E-mail of consumer.

gender

O

Alphanumeric

1

Gender of consumer.

f and m are allowed values.

date_of_birth

O

YYYY-MM-DD

10

Consumer’s date of birth

phone

O

Alphanumeric

32

Consumer’s phone number

street1

O

Alphanumeric

70

Street information part 1 of consumer.

This field is optional, but mandatory if city or country is specified.

street2

O

Alphanumeric

128

Street information part 2

city

O

Alphanumeric

32

City of consumer

This field is optional, but mandatory if street1 or country is specified.

state

O

Alphanumeric

32

State of consumer

country

O

Alphanumeric

3

Country of consumer.

This field is optional, but mandatory if street1 or city is specified Please refer to Countries and Currencies.

postal_code

O

Alphanumeric

16

Postal code of consumer

entry_mode

O

Alphanumeric

-

This is information about the channel used for this transaction.

Can be one of the following: mail-order, telephone-order, ecommerce, mcommerce or pos.

ip_address

O

Alphanumeric

15

IP address

order_number

O

Alphanumeric

64

Order number

order_detail

O

Alphanumeric

1024

Order detail

descriptor

O

Alphanumeric

100

Description of the transaction. It identifies the transaction.

creditor_id

E

Empty

0

"Provide empty value" for this field by using the construct ,,.

mandate_id

E

Empty

35

"Provide empty value" for this field by using the construct ,,.

mandate_signature_date

E

Empty

0

"Provide empty value" for this field by using the construct ,,.

due_date

E

Empty

0

"Provide empty value" for this field by using the construct ,,.

custom_field-name_1

O

Alphanumeric

36

Name of custom field 1.

custom_field_value_1

O

Alphanumeric

256

Value of custom field 1. In this field the merchant can send additional information.

custom_field-name_2

O

Alphanumeric

36

Name of custom field 2.

custom_field_value_2

O

Alphanumeric

256

Value of custom field 2. In this field the merchant can send additional information.

custom_field-name_3

O

Alphanumeric

36

Name of custom field 3.

custom_field_value_3

O

Alphanumeric

256

Value of custom field 3. In this field the merchant can send additional information.

notification_transaction_state

O

12

Transaction notification state. For datatype please refer to Transaction States.

notification_url

O

Alphanumeric

256

URL for notification

merchant_crm_id

O

Alphanumeric

64

CRM (Customer-Relationship-Management) ID of Merchant

periodic_type

O

Alphanumeric

11

This is information about the periodicity of this transaction.

Can be one of the following: installment, recurring.

sequence_type

E

Empty

10

"Provide empty value" for this field by using the construct ,,. For a sample, please look at the Batch Processing Sample.

For a sample, please look at the Request Sample for Batch Processing.

SEPA Request

Field Cardinality Datatype Size Description

merchant_account_id

M

Alphanumeric

36

Account ID of the merchant.

request_id

M

Alphanumeric

150

Unique request ID for each Transaction (= Merchant Transaction ID).

payment_method_id

M

Alphanumeric

15

Payment method.

Only SEPA DD, SEPA CT and Credit Card are allowed.

transaction_type

M

Alphanumeric

30

Transaction type (direct relationship to payment method).

parent_transaction_id

O

Alphanumeric

36

Transaction ID of authorization or parent transaction, if either transaction is available and should be referred to.

requested_amount

O

Numeric

15

Amount in decimal number. Max length = total number of digits.

The number of digits after the decimal point depends on the currency. 100.000 INR (Indian Rupee) but 100.00 EUR

requested_amount_currency

O

Alphanumeric

3

Currency

Currently only EUR is allowed.

account_number

E

Empty

0

"Provide empty value" for this field by using the construct ,,.

iban

O

Alphanumeric

34

Account holder IBAN.

bic

O

Alphanumeric

11

Account holder BIC (BIC may have 8 or 11 characters).

token_id

E

Empty

0

"Provide empty value" for this field by using the construct ,,.

card_type

E

See Card Types defined in API

0

"Provide empty value" for this field by using the construct ,,.

expiration_month

E

Empty

0

"Provide empty value" for this field by using the construct ,,.

expiration_year

E

Empty

0

"Provide empty value" for this field by using the construct ,,.

first_name

O

Alphanumeric

32

First name of consumer.

last_name

O

Alphanumeric

32

Last name of consumer.

email

O

Alphanumeric

64

E-mail of consumer.

gender

O

Alphanumeric

1

Gender of consumer.

Only f or m are allowed values.

date_of_birth

O

YYYY-MM-DD

10

Consumer’s date of birth.

phone

O

Alphanumeric

32

Consumer’s phone number.

street1

O

Alphanumeric

70

Street information part 1 of consumer. This field is optional, but mandatory if city or country is specified.

street2

O

Alphanumeric

128

Street information part 2.

city

O

Alphanumeric

32

City of consumer. This field is optional, but mandatory if street1 or country is specified.

state

O

Alphanumeric

32

State of consumer.

country

O

Alphanumeric

3

Country of consumer. This field is optional, but mandatory if street1 or city is specified. Please refer to Countries.

postal_code

O

Alphanumeric

16

Postal code of consumer.

entry_mode

E

Alphanumeric

0

"Provide empty value" for this field by using the construct ,,.

ip_address

O

Alphanumeric

15

IP address.

order_number

O

Alphanumeric

64

Order number.

order_detail

O

Alphanumeric

1024

Order detail.

descriptor

O

Alphanumeric

100

Description of the transaction. It identifies the transaction.

creditor_id

O

Alphanumeric

35

Creditor ID.

mandate_id

O

Alphanumeric

35

Mandate ID.

mandate_signature_date

O

YYYY-MM-DD

10

Sign Date of Mandate. Mandate signature date is always today or in the past.

due_date

O

YYYY-MM-DD

10

Due Date of transaction.

Due Date is always in the future.

If this field is left empty, Wirecard will automatically calculate the due date. For more information about 'due date' please refer to Due Date.

custom_field-name_1

O

Alphanumeric

36

Name of custom field 1.

custom_field_value_1

O

Alphanumeric

256

Value of custom field 1. In this field the merchant can send additional information.

custom_field-name_2

O

Alphanumeric

36

Name of custom field 2.

custom_field_value_2

O

Alphanumeric

256

Value of custom field 2. In this field the merchant can send additional information.

custom_field-name_3

O

Alphanumeric

36

Name of custom field 3.

custom_field_value_3

O

Alphanumeric

256

Value of custom field 3. In this field the merchant can send additional information.

notification_transaction_state

O

-

12

Transaction notification state. For datatype please refer to Transactions States.

notification_url

O

Alphanumeric

256

URL for notification

merchant_crm_id

O

Alphanumeric

64

CRM (Customer-Relationship-Management) ID of Merchant

periodic_type

O

Alphanumeric

11

Periodic type - Supported for recurring Direct Debit not for Credit.

Only recurring is allowed. This field is optional, but if this field is defined, sequence_type must also be provided.

sequence_type

C

Alphanumeric

10

Sequence type, if periodic type is set to recurring.

Only first, recurring or final are allowed values.

This field is only required, if periodic_type is defined.

For a sample, please look at the Request Sample for Batch Processing

Response

Response fields are the same for SEPA and Credit Card.
Field Cardinality Datatype Size Description

batch_id

Mandatory

Alphanumeric

36

Batch internal ID for the request.

transaction_id

Mandatory

Alphanumeric

36

The transaction ID represents the end-to-end flow of a transaction and is used to identify transactions within the banking system. It is generated by Wirecard.

request_id

Mandatory

Alphanumeric

150

Unique request ID for each Transaction (= Merchant Transaction ID)

transaction_type

Mandatory

30

Transaction type (direct relationship to payment method); ONLY pending-credit or pending-debit are allowed. Please refer to Transaction States

requested_amount

Mandatory

Numeric

15

Amount in decimal number. Max length = total number of digits.

The number of digits after the decimal point depends on the currency.

Example: 100.000 INR (Indian Rupee) but 100.00 EUR

requested_amount_currency

Mandatory

3

Currency, currently only EUR allowed. Please refer to Currencies

notification_transaction_state

Mandatory

12

Transaction notification state. Please refer to Transaction States

transaction_state

Mandatory

12

Please refer to Transaction States

token_id

Optional

Alphanumeric

N/A

empty value.

status_code

Mandatory

Alphanumeric

N/A

See Transaction Status.

If multiple codes are applicable, a pipe separated list of codes will be supplied.

status_description

Mandatory

N/A

See Transaction Status.

If multiple codes are applicable, a pipe separated list of codes will be supplied.

Example:

"The First Name has not been provided. Please check your input and try again. |The Last Name has not been provided. Please check your input and try again."

completion_time_stamp

Mandatory

N/A

ISO 8601 – combined date and time in UTC. Example: "2014-06-24T09:56:50+00:00"

order_number

Optional

Numeric

64

Order number

For a sample, please look at the Request Sample for Batch Processing

Custom URL: