Menu

User Tools

Create PDF

Site Tools


This is an old revision of the document!


Installment: RatePAY

General information

To integrate and offer the payment method installment for your consumers in your online shop you need to fulfill some important requirements:

  • By default only German consumers are allowed to use installment as payment method. Please contact RatePAY to extend the list of supported countries.
  • Check your individual conditions with RatePAY regarding minimum and maximum amount of orders, minimum age of your consumer, address of your consumer and accepted currencies.
  • Submit additional parameters which are required by RatePAY for checking the credit reliability of your consumer.

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

Please visit RatePAY for further information and details.

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 Installment 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.

Please note the length restrictions that apply for this payment method and the following shopping basket parameters.

Shopping basket data
Parameter Within fingerprint Data type Short description
basketItem(n)ArticleNumber Required if used. Alphanumeric with special characters and with a variable length of up to 254 characters. Unique ID of article n in shopping basket.
basketItem(n)Description Required if used. Alphanumeric with special characters and with a variable length of up to 50 characters. Product description of article n in shopping basket.

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 128 characters. Unique order reference ID sent from merchant to financial institution.

Parameter basketItem to reedem vouchers

If the consumer in your online shop redeems a voucher or coupon during the payment process, the optional request parameter basketItem must be used. This parameter must contain 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.

Back-end operation

The following information is valid for the back-end operation:

For deposit the parameters for the basket information are required. 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.

Shopping basket parameters

Examples

The following examples are intended to contribute to a better understanding of how to make a full or partial deposit.

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

Number of items Description Number Price per unit Tax per unit
1 Product A1 A001 EUR 10,05 EUR 1,50
2 Product A2 A002 EUR 20,80 EUR 2,40
1 Shipping S001 EUR 5,90 EUR 0,00

Examples for back-end operation "deposit"

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

Parameter name Parameter value Description
basketAmount 63,85 = 1 x EUR 10,05 + 1 x EUR 1,50 + 2 x EUR 20,80 + 2 x EUR 2,40 + 1 x EUR 5,90
basketCurrency EUR Currency as ISO code.
basketItems 3 3 different products in shopping basket.
basketItem1ArticleNumber A001
basketItem1Quantity 1
basketItem1UnitPrice 10,05 Price per item.
basketItem1Tax 1,50 Total amount of tax for item 1.
basketItem1Description Product A1
basketItem2ArticleNumber A002
basketItem2Quantity 2
basketItem2UnitPrice 20,80 Price per item.
basketItem2Tax 4,80 Total amount of tax for item 2.
basketItem2Description Product A2
basketItem3ArticleNumber S001
basketItem3Quantity 1
basketItem3UnitPrice 5,90 Price per item.
basketItem3Tax 0 Total amount of tax for item 3.
basketItem3Description Shipping

When making a full deposit of all items, the values of the parameters basketAmount and amount are the same, in this example EUR 63,85.

2. 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. For this you need to specify the items to be deposited via the basket parameters.

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

Parameter name Parameter value Description
basketAmount 11,55 = 1 x EUR 10,05 + 1 x EUR 1,50
basketCurrency EUR Currency as ISO code.
basketItems 1 1 product in shopping basket.
basketItem1ArticleNumber A001
basketItem1Quantity 1
basketItem1UnitPrice 10,05 Price per item.
basketItem1Tax 1,50 Total amount of tax for item 1.
basketItem1Description Product A1

When making a partial deposit of items, the values of the parameters basketAmount and amount are the same, in this example EUR 10,05.


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.