Menu

User Tools

Create PDF

Site Tools


deposit

deposit is one of the transaction-based operations (back-end operations) offered by Wirecard Checkout Page and Wirecard Checkout Seamless. This operation causes an approval (authorization) to be converted into a deposit (captured payment). This operation is executed by you if an order of a consumer has been accepted. Additionally a daily-closing is automatically opened when there is no one already open for this payment method and currency.

This operation can be reversed with the operation depositReversal when the corresponding daily-closing has not yet been done and the financial services provider and the payment method supports this operation.

The required order of the required request parameter values when computing the fingerprint for Wirecard Checkout Page is:
customerId, shopId, toolkitPassword, secret, command, language, orderNumber, amount and currency.

The required order of the required request parameter values when computing the fingerprint for Wirecard Checkout Seamless is:
customerId, shopId, password, secret, language, orderNumber, amount and currency.

If you want to do split capture (e.g. 100 authorized, 2×50 deposited), e.g. if you want to partially ship the items in your consumers shopping basket, this needs to be supported by your financial service provider. If so, you need to send some additional information about the items you want to ship and deposit. Use the additional optional request parameters for the shopping basket.

When submitting these additional optional request parameters you need to append the relevant parameters when calculating the fingerprint according to the fingerprint order described in the corresponding section.

Additional required request parameters

Parameter Data type Short description
orderNumber Numeric with a variable length of up to 9 digits. Order number of payment.
amount Amount Deposited amount.
currency Alphabetic with a fixed length of 3 or numeric with a fixed length of 3. Currency code of amount.

Additional optional request parameters

For deposits there are some additional parameters available. When multiple deposits and refunds are made the orderReference may not suffice as sole reference. An additional reference for each operation can therefore be set with the parameter merchantReference.

Parameter Within fingerprint Data type Short description
merchantReference Required if used. ASCII with a variable length of up to 128 characters, but may differ for specific payment methods. Unique order reference ID sent from merchant to financial institution.
customerStatement Required if used. Alphanumeric with a variable length of up to 254 characters that may be restricted for specific payment methods. Text displayed on bank statement issued to your consumer by the financial service provider.

Shopping basket data

On the other hand for some payment methods information about the basket items on each deposit is required, especially if the items are shipped in multiple shipments and each shipment is separately deposited. For this purpose the following basket parameters are available.

Although the following parameters are in general optional, either all parameters need to be set or none, except for basketItem(n)Description and basketItem(n)ImageUrl which remain optional.

Parameter Within fingerprint Data type Short description
basketItems Required if used. Numeric. Number of items in shopping basket.
basketItem(n)ArticleNumber Required if used. Alphanumeric with special characters. Unique ID of article n in shopping basket.
basketItem(n)Description Required if used. Alphanumeric with special characters. Product description of article n in shopping basket.
basketItem(n)ImageUrl Required if used. Alphanumeric with special characters. URL to an image of each item.
basketItem(n)Name Required if used. Alphanumeric with special characters. Product name of article n in shopping basket.
basketItem(n)Quantity Required if used. Numeric Items count of article n in shopping basket.
basketItem(n)UnitGrossAmount Required if used. Amount Price per unit of article n in shopping basket with taxes.
basketItem(n)UnitNetAmount Required if used. Amount Price per unit of article n in shopping basket without taxes.
basketItem(n)UnitTaxAmount Required if used. Amount Tax amount per unit of article n in shopping basket.
basketItem(n)UnitTaxRate Required if used. Percentage of tax, e.g. 20 or 19.324. Up to 3 fractions. Percentage of tax per unit of article n in shopping basket.

Since 21st April, 2016 the following parameters shall not be used since they result in technical restraints e.g. regarding the calculation of taxes. Existing implementations may still use these parameters, however, a complete replacement with the parameters mentioned above is recommended. Partial replacement leads to an error, therefore use all new parameters and remove all legacy parameters when replacing. If the legacy parameters are passed in parallel to the parameters described above, the data of the legacy parameters are ignored.

LEGACY Shopping basket data
Parameter Data type Short description
basketAmount Amount Overall amount of shopping basket.
basketCurrency Alphabetic with a fixed length of 3 or numeric with a fixed length of 3. Code of currency based on ISO 4217.
basketItem(n)UnitPrice Amount Price per unit of article n in shopping basket without taxes.
basketItem(n)Tax Amount Tax amount of article n in shopping basket.

Since the purpose and handling of these parameters are similar visit request parameters on shopping basket data for further information and details.

Fingerprint calculation

The required order of the parameter values when computing the fingerprint is:
merchantReference, customerStatement, basketItems, basketItem1ArticleNumber, basketItem1Quantity, basketItem1Description, basketItem1Name, basketItem1ImageUrl, basketItem1UnitGrossAmount, basketItem1UnitNetAmount, basketItem1UnitTaxAmount, basketItem1UnitTaxRate, basketItem2ArticleNumber, basketItem2Quantity, basketItem2Description, basketItem2Name, basketItem2ImageUrl, basketItem2UnitGrossAmount, basketItem2UnitNetAmount, basketItem2UnitTaxAmount,basketItem2UnitTaxRate, …

Payment facilitator model

When handling credit card payments in a marketplace with multiple merchants, each payment needs to be individually deposited for each merchant and, if necessary, also a refund or recur payment is carried out for each merchant.

When depositing a partial amount for one of the merchants, the payment facilitator parameters must be provided for the back-end operation deposit but with the data of the respective merchant. The shopping basket data should also be provided containing the items the respective merchant has shipped.

Regarding the fingerprint calculation, the relevant payment facilitator parameters are appended to the shopping basket parameters in the described order.

Additional response parameters

The following parameter is used in addition to the response parameters needed for all back-end operations (Wirecard Checkout Page and Wirecard Checkout Seamless).

Parameter Data type Short description
paymentNumber Numeric with a variable length of up to 9 digits. A new payment number is returned if a new payment object has been created due to a split capture.

FAQ

Is it possible to do split capture?

Yes, Wirecard does support this operation; however, it must also be supported by your financial service provider.


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.