Wirecard Documentation

authorization

Performs a creditworthiness check at the moment when the consumer makes an order. All order items must be listed for the shopping basket. The authorization amount must match the value of the items in the basket.

authorization samples

capture-authorization

Used to capture the reserved funds at the moment when some or all goods are physically delivered to the consumer. Available only on successful authorization response which wasn’t voided nor fully captured. Partial (and multiple) capture is allowed, as long as the authorization limit is not exceeded. Basket items only list the items that were delivered to the consumer in this delivery, not the ones that were delivered before or are waiting to be delivered. The total amount of the capture must be the value of the items in the basket.

capture-authorization samples

void-authorization

Used when the consumer wishes to cancel some or all (not yet shipped) items from the order. Available only for a successful authorization response which was not yet voided or captured. Partial and multiple void are allowed, until all items from the order are canceled or shipped. Basket items only list those items which are canceled from the order.

void-authorization samples

refund-capture

Used when the consumer wishes to return some or all delivered goods. Available on a successful capture-authorization. Partial and multiple refunds are allowed, until all delivered items have been returned. Basket items list only those items which are returned to the merchant.

refund-capture samples

credit

Used when the merchant wishes to grant a discount on an existing order. Items from this order may already be delivered to the consumer. Available on a successful capture-authorization. Multiple credits are allowed, but the overall sum of credits must not exceed the value of the goods delivered to the consumer. The credit transaction must include a basket item representing the discount. The credit transaction must refer to the successful authorization transaction-id.

credit samples

merchant-account-id

M

String

36

Unique identifier for a merchant account

request-id

M

String

150

This is the identification number of the request. It has to be unique for each request.

transaction-type

M

String

30

This is the type for a transaction: authorization, capture, void-authorization, refund-capture and credit are supported for Wirecard Payment in Installments.

requested-amount

M

Numeric

18.3

This is the amount of the transaction. The amount of the decimal place depends on the currency. The amount must be between a defined minimum value and a defined maximum value.

requested-amount/@currency

M

String

3

This is the currency of the transaction. For Germany and Austria, only EUR is allowed. Switzerland additionally accepts CHF.

order-detail

O

String

65535

Details of the order filled by the merchant.

order-number

M

String

64

The order number from the merchant.

consumer-id

O

String

50

Merchant’s identifier for the consumer.

locale

O

String

5

It is used to control the language of the consumer message and the correspondence to the consumer. Allowed values:
fr (French)
en (English)
nl (Dutch)
de (German)
If empty or sent with an incorrect value, de is used by default.

invoice-number

O

String

32

Merchant’s invoice identifier, optional for capture-authorization request.

@name

M

String

15

The name of the Payment Method is ratepay-install.

first-name

M

String

32

Account holder’s first name.

last-name

M

String

32

Account holder’s last name.

email

M

String

64

Account holder’s email address.

phone

M

String

32

Account holder’s phone number.

date-of-birth

M

String

10

Account holder’s date of birth. Format (according to ISO 8601): YYYY-MM-DD
This format cannot be customized.

gender

O

Enumeration

1

Account holder’s gender.

street1

M

String

128

The first line of the street address of the account holder. Must include house number.

street2

O

String

128

The second line of the street address of the account holder.

city

M

String

32

The city of the address of the account holder.

state

O

String

32

The state or province of the address of the account holder.

country

M

String

2

The country id of the address of the account holder. The two-letter country code follows ISO 3166-1 alpha-2.

postal-code

M

String

16

The postal code or ZIP of the address of the account holder.

Consumer’s bank account details.

bank-name

M

String

100

The name of the consumer’s bank.

iban

M/O

String

34

The international bank account number (IBAN) required in a bank transfer. It is an international standard for identifying bank accounts across national borders. The current standard is ISO 13616:2007, which indicates SWIFT as the formal registrar.
Allowed characters: [a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[0-9]{7}([a-zA-Z0-9]?){0,16}.
Mandatory if account-number is not used.

bic

M/O

String

15

The bank identifier code (BIC) in bank transfer.
Allowed characters: ([a-zA-Z]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3}).
Mandatory if iban is used

account-number

M/O

String

34

The number designating a bank account used nationally.
Mandatory if iban is not used.

bank-code

M/O

String

15

The national bank sorting code for national bank transfers.
Mandatory if account-number is used.

name

M

String

256

Name of the item in the basket.

article-number

M

String

256

EAN or other article identifier for merchant.

amount

M

Decimal

18.3