Menu

User Tools

Create PDF

Site Tools


This is an old revision of the document!


Invoice by Wirecard

General information

To integrate and offer Invoice by Wirecard for your consumers in your online shop you need to fulfill some important requirements:

  • Invoice by Wirecard is only available for merchants and consumers resident in Germany, Austria and Switzerland.
  • Check your individual conditions with Wirecard regarding minimum and maximum amount of orders, minimum age of your consumer, country of residence of your consumer and accepted currencies.
  • Submit additional parameters which are required by Wirecard for checking the credit reliability of your consumer.

Do not offer this payment method to your consumer in your online shop unless these requirements are met.

After the checkout process Wirecard sends an e-mail to your consumer with an invoice attached. This invoice includes a letterhead with the name and address of your company and the corresponding financial details to settle the payment.

Order flow diagram

For a visual representation of the order flow behavior and associated transaction-based operations of this payment method we invite you to have a look at the respective order flow diagram.

Required request parameters

For payment method Invoice by Wirecard the otherwise optional request parameters for consumer billing data and shopping basket data are required. For further information on these parameters go to Consumer billing data and Shopping basket data.

Optional request parameters

The optional request parameters customerStatement and orderReference are more restricted with regard to their length and allowed characters than are other general request parameters.

Parameter Data type Short description
customerStatement ASCII with a variable length of up to 254 characters. Text displayed on bank statement issued to your consumer by the financial service provider.
orderReference ASCII with a variable length of up to 50 characters. Unique order reference ID sent from merchant to financial institution.
consumerMerchantCrmId Alphanumeric with a variable length of up to 50 characters. Unique ID identifying the consumer of your online shop, e.g. from your CRM system. The parameter must not be a human readable e-mail address.

Parameter consumerMerchantCrmId

The parameter is understood as unique ID identifying the consumer in your online shop, e.g. using data from your Customer Relationship Management (CRM) system. However, Invoice by Wirecard must not receive any data or information that allow to draw any conclusions on the final consumer.

Please note that Invoice by Wirecard refers to the new parameter as Merchant-Consumer-ID which is an internal customer identifier of the merchant system. In Wirecard interfaces and documentation consumerMerchantCrmId is used.

Technical information about the implementation of consumerMerchantCrmId can be found below. For any additional information on the introduction of this new parameter please contact Invoice by Wirecard.

The parameter consumerMerchantCrmId has to be set by the merchant using Wirecard Checkout Page or Wirecard Checkout Seamless for initiations via WCP, WCP server-to-server initiations and WCS front-end initiation.

Also, the parameter consumerMerchantCrmId is part of the fingerprint.

FIXME - was tun mit WCE, so war es bei paysafecard drinnen ????

Invoice by Wirecard and WCE/Qtill

The following information is intended ONLY for merchants using payment method Invoice by Wirecard and Wirecard Checkout Enterprise.

In order to set the new parameter consumerMerchantCrmId, merchants using Wirecard Checkout Enterprise must use the most recent JAPI version. Please update your JAPI version accordingly.

Click JAPI to download the latest JAPI version.

For any additional information or help contact our support teams.

Parameter basketItem to reedem vouchers

If the consumer in your online shop redeems a voucher or coupon during the payment process, a basket item must be added. This item contains the negative amount corresponding to the voucher or coupon value. For vouchers with percentage discount, the percentage to be deducted must first be converted into an absolute value. The total basket amount displayed to the consumer in your online shop will then show both the voucher amount and the total basket amount reduced by this voucher amount.

Additional response parameters

When using this payment method in your online shop, we will return additional parameters to your online shop. These parameters are specific to this payment method and are only returned when your consumer selects this payment method in your online shop.

Parameter State Data type Short description
gatewayReferenceNumber Success Alphanumeric with special characters and a variable length of up to 255.
E.g. 440208fa-6057-4c1f-8034-732d6050395c.
Technical reference number of the payment processing at Wirecard.
providerReferenceNumber Success Alphanumeric with special characters and a variable length of up to 255.
E.g. DG0511345U8.
Reference number of the invoice.

Back-end operations

If you make partial shipments of the ordered items you can only deposit the amount for the shipped items and need to specify these items via the shopping basket parameters.

If you make a partial refund because one or several articles were sent back to you, you need to specify in the basket parameters those items which remain at your consumer and not those which are sent back to you. Therefore the basket amount and the refund amount are complementary.

If you want to refund a certain amount to your consumer although no items are sent back to you, e.g. in case an article arrived damaged, or redeem a certain voucher value after payment was made, you have to send the optional request parameter transactionIdentifier. This special refund can only be carried out after the full amount was deposited and a day-end closing was performed.

For deposit and refund the parameters for the basket data are required. Please refer to the parameter description in table shopping basket parameters for further details.

The total refunded amount, including previous refunds, must be less or equal to the deposited amount.

Optional request parameter

The following request parameter needs to be specified at refunds with empty basket data.

Parameter Data type Short description
transactionIdentifier Enumeration Set to CREDIT to refund your consumer a certain amount without having returned any articles.

Examples

The following examples are intended to contribute to a better understanding of how to make a full or partial deposit and full or partial refund and using the optional request parameter transactionIdentifier.

In all examples the shopping basket of your consumer in your online shop is assumed to contain the following items:

Quantity Description Number Price per unit Tax per unit
1 Item A1 A001 EUR 10,80 EUR 1,80
2 Item A2 A002 EUR 14,94 EUR 2,49
1 Shipping S001 EUR 5,90 EUR 0,00

Examples for back-end operation "deposit"

The parameters for making a full deposit of all items in the shopping basket of your consumer would be:

Parameter name Value Description
basketItems 3 3 different items in shopping basket.
basketItem1ArticleNumber A001
basketItem1Quantity 1
basketItem1Name Item A1
basketItem1UnitGrossAmount 10,80 Gross price per item 1.
basketItem1UnitNetAmount 9,00 Net price per item 1.
basketItem1UnitTaxAmount 1,80 Tax for item 1.
basketItem1UnitTaxRate 20,000 Tax rate for item 1.
basketItem2ArticleNumber A002
basketItem2Quantity 2
basketItem2Name Item A2
basketItem2UnitGrossAmount 14,94 Gross price per item 2.
basketItem2UnitNetAmount 12,45 Net price per item 2.
basketItem2UnitTaxAmount 2,49 Tax for item 2.
basketItem2UnitTaxRate 20,000 Tax rate for item 2.
basketItem3ArticleNumber S001
basketItem3Quantity 1
basketItem3Name Shipping
basketItem3UnitGrossAmount 5,90 Gross price per item 3.
basketItem3UnitNetAmount 5,90 Net price per item 3.
basketItem3UnitTaxAmount 0,00 Tax for item 3.
basketItem3UnitTaxRate 0,000 Tax rate for item 3.

If you make partial shipments of the ordered items you need to make partial deposits, i.e. deposit only the amount for the shipped items specified in the basket parameters.

Based on the above information, the following example assumes that only item 1 is shipped and deposited. The shipping costs are deposited with the final shipment. The parameters for making a partial deposit of this item would be:

Parameter name Parameter value Description
basketItems 1 1 item in shopping basket.
basketItem1ArticleNumber A001
basketItem1Quantity 1
basketItem1Name Item A1
basketItem1UnitGrossAmount 10,80 Gross price per item 1.
basketItem1UnitNetAmount 9,00 Net price per item 1.
basketItem1UnitTaxAmount 1,80 Tax for item 1.
basketItem1UnitTaxRate 20,000 Tax rate for item 1.

Examples for back-end operation "refund"

The examples for a full or partial refund are the same as for the back-end operation deposit, except that when making a full refund, the basket is empty and when making a partial refund, you specify the items which remain with your consumer. If the item number 2 is refunded and you do not refund the shipping costs, the basket is:

Parameter name Parameter value Description
basketItems 1 1 item in shopping basket.
basketItem1ArticleNumber A001
basketItem1Quantity 1
basketItem1Name Item A1
basketItem1UnitGrossAmount 10,80 Gross price per item 1.
basketItem1UnitNetAmount 9,00 Net price per item 1.
basketItem1UnitTaxAmount 1,80 Tax for item 1.
basketItem1UnitTaxRate 20,000 Tax rate for item 1.
basketItem2ArticleNumber S001
basketItem2Quantity 1
basketItem2Name Shipping
basketItem2UnitGrossAmount 5,90 Gross price for shipping.
basketItem2UnitNetAmount 5,90 Net price for shipping.
basketItem2UnitTaxAmount 0,00 Tax for shipping.
basketItem2UnitTaxRate 0,000 Tax rate for shipping.

Example for using the parameter transactionIdentifier

If you make a refund of a certain amount without your consumer having returned any articles and after day-end closing was performed, you need to send the parameter transactionIdentifier with the value CREDIT and specify an arbitrary item with the amount to be refunded. The refunded amount does not need to correspond to any actual item price in the original basket.

Parameter name Parameter value Description
transactionIdentifier CREDIT
basketItems 1 1 item as credit.
basketItem1ArticleNumber C001
basketItem1Quantity 1
basketItem1Name Credit for delayed delivery. Credit description.
basketItem1UnitGrossAmount 12,00 Gross price per item 1.
basketItem1UnitNetAmount 10,00 Net price per item 1.
basketItem1UnitTaxAmount 2,00 Tax for item 1.
basketItem1UnitTaxRate 20,000 Tax rate for item 1.

This website uses cookies to deliver the best service to you. By continuing to browse the site, you are agreeing to our use of cookies.