About Ratepay
General information about Ratepay
With payment by invoice you can reduce the number of uncompleted orders in your online shop by up to 81%. This increases your turnover and your sales. Therefore Computop Paygate allows purchase on account in several European countries with payment guarantee. Rate payment at the online shop motivates your customers to order high value baskets. This also increases your turnover. Therefore Computop Paygate offers guaranteed hire purchase within several European countries.
With Ratepay you profit as a merchant from a full invoice and hire purchase service. Therefore you pass on all the invoice data during the order to the service provider. That than takes over the complete billing and debtor management. As merchant you get a payment guarantee. Furthermore Ratepay offers classical hire purchase and SEPA direct debit.
Ratepay guarantees an online consent in seconds for purchases by instalment during the order process. A PostIdent-process is not necessary. Ratepay transfers the invoice amount rapidly to the merchant and bears the non-payment risk themselves.
| Logo |
|
|---|---|
| Info | Ratepay offers payments solutions for purchases on invoice and hire purchases as well as direct debits with full processing and carries to complete risk of payments defaults. |
| Type | Payments by Invoice and Installments |
Further information can be found on the webpage of Ratepay (http://www.ratepay.com).
Process flow chart
Paygate interface
Format Description a alphabetical as alphabetical with special characters n numeric an alphanumeric ans alphanumeric with special characters ns numeric with special characters bool boolean expression (true or false) 3 fixed length with 3 digits/characters ..3 variable length with maximum 3 digits/characters enum enumeration of allowed values dttm ISODateTime (YYYY-MM-DDThh:mm:ss) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
Ratepay invoice and hire purchase
A payment with Ratepay consists of several transaction steps. At the start an initialisation is necessary, which returns the permissible methods of payment for the customer: purchase on invoice, hire purchase or direct debit. If the customer wants hire purchase the instalment calculator must be displayed. The payment is subsequently created, confirmed, changed if needed and finally captured. Credits are also possible.
Computop Ratepay has 5 different requests which must be carried out in the payment process depending on the situation and progress. Computop converts these requests into the corresponding Ratepay requests. In this case the following mapping applies:
Initialising Ratepay payments
In order to initialise a Ratepay payment via server-to-server communication, please use the following URL:
https://www.computop-paygate.com/ratepay.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameters for Ratepay payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Result parameters for Ratepay payments
Ratepay instalment calculator
The Ratepay instalment calculator (control surface implemented by the merchant) must be displayed if the end customer is expected to make a purchase by instalment. In this case the instalments are calculated on the basis of the amount + e.g. the duration (or the duration is calculated based on the instalments).
Use the following URL to display the Ratepay instalment calculator:
https://www.computop-paygate.com/ratepay.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameters for Ratepay instalment calculator
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Result parameters for Ratepay instalment calculator
Although the configuration of the instalment calculator is firmly specified by Ratepay, it may be helpful to query this configuration before further processing in order to avoid subsequent errors. Use the following URL to do this:
https://www.computop-paygate.com/ratepay.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameters for querying the configuration of the Ratepay instalment calculator
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters of the configuration query of the Ratepay instalment calculator
Create payment process
In order to create a payment transaction with Ratepay, please use the following URL:
https://www.computop-paygate.com/ratepay.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameters for the creation of a Ratepay payment
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for the creation of a Ratepay payment
Confirm payment transaction
In order to conform a payment transaction with Ratepay, please use the following URL:
https://www.computop-paygate.com/ratepay.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameters for confirming a Ratepay payment
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for confirmung a Ratepay payment
Capture a Ratepay payment transaction (full / partial capture)
In order to capture a payment transaction with Ratepay, please use the following URL:
https://www.computop-paygate.com/capture.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameters for capture of a Ratepay payment
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for capturing a Ratepay payment
Cancellation / return of Ratepay payments
In order to cancel a Ratepay payment partial or in full or the make changes on a payment, please use the following URL:
https://www.computop-paygate.com/ratepay.aspx |
Notice: There are constraints for the different actions (event tokens) regarding when actions can be carried out. Before the capture only the following are allowed: FC (full cancellation), PC (partial cancellation), CO (change order). Only after the capture are allowed FR (full return) and PR (partial return).
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameters for cancellation / change of a Ratepay payment
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for cancellation / change of a Ratepay payment
Crediting Ratepay payments
In order to credit a payment transaction with Ratepay, please use the following URL:
https://www.computop-paygate.com/ratepay.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameters for crediting a Ratepay payment
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for crediting a Ratepay payment
ShoppingBasket parameter explained
The ShoppingBasket parameter describes the affected transaction items and is comprised of various parameters. The individual parameters within a shopping cart are separated with a “;”. Only enter the values and not the associated parameter name. Unused optional parameters must be transferred as an empty field. Each further item is separated from the last with a “+”. For an example see table below.
The following table describes the individual values within the ShoppingBasket:
Parameters within the shopping basket
Example of a shopping basket with 3 articles:
ShoppingBasket=A;1;1;bed;10000;1900;01233;1000;blue+B;2;1;towel;3000;1900;0234;;180x200+C;5;1;pillow;1000;1900;;;
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing a Ratepay capture or change and which information can be found within the response file about the payment status.
For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.
Following table gives an overview of all batch versions that are possible for a specific action an their specialities:
Description of the possible batch versions
The structure for a capture or credit within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> Ratepay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>) Ratepay,Change,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>) FOOT,<CountRecords>,<SumAmount>
Example for Master MID function:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount
The following table describes the individual fields and values used within the data set (record) in the batch file:
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks the following way:
HEAD,<MerchantID>,<Date>,<Version> Ratepay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>),<Status>,<Code> Ratepay,Change,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>),<Status>,<Code> FOOT,<CountRecords>,<SumAmount>
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
Description of result parameters within the record for Batch files