Ratepay Invoice

Overview - Ratepay Invoice

With Ratepay - Invoice, customers can make online purchases and pay with an open invoice after delivery. Each merchant specifies a payment term, in which the money is collectible.

If no payment is initiated seven days after the expiration of the payment term, Ratepay sends a reminder to the customer. If no payment is initiated in another seven days, Ratepay sends a warning (Mahnung).

The main advantages for merchants using Ratepay - Invoice are:

• Ratepay overtakes the creditor's role and provides a payment guarantee to the merchant;
• The entire user experience takes place on the merchant's website;
• As with all Ratepay payment methods, the risk of customer payment default is transferred from the merchant to RatePAY.

The main advantages for customers using Ratepay - Invoice are:

• The customer could inspect the goods before payment;
• Ratepay - Invoice is free to use and there are no additional fees;
• There is no need to create a user account with Ratepay to use Invoice.

Activation - Ratepay Invoice

To activate Ratepay as a payment method and to add it to your PayEngine Merchant Center, you need to complete the onboarding journey.

Please provide our support with the following information:

• Profile ID
• Security Code
• ShopID
• Device Ident AppID

Customer Experience - Ratepay Invoice

Step	Description	Image
1	Choose Rechnung (Ratepay - Invoice)
2	Click Pay
2	Success or Failure Notification

Payengine Details - Ratepay Invoice

General

Supported Features & Services

Integration Types

Integration via API - Ratepay Invoice

Technical Flow

Specifications - Ratepay Invoice

Prerequisites for Authorizing Transactions

Customer

The specific request parameters for creating Customer objects are different when the end-user is individual (B2C cases) or organization (B2B cases).

Customer in B2C cases

Create Customer - Request Parameters

Customer in B2B cases

Create Customer - Request Parameters

Persona

Create Persona - Request Parameters

Billing/Shipping Address

Create Billing/Shipping Address - Request Parameters

Device Identification for Ratepay Payment Methods

In general Device Identification can be defined as a technique used to establish a "fingerprint" of a user's device used to access certain website or application of interest in order to track device activity and determine linkages between other devices.

The main purpose of Device Identification technique is to support prevention of possible fraudulent operations.

Device Identification is a mandatory prerequisite for all Ratepay payment methods. It has to be created prior to execution of any authorizing transactions (Preauth or Debit).

For API integration of Ratepay payment methods it's recommended merchants to follow three steps regarding Device Identification:

1) Creating Device Ident using POST method

A POST request with empty body has to be directed to the following endpoints:

• for TM environment - - https://pptest.payengine.de/widget/ratepay/device-ident/create/ratepay-invoice - https://pptest.payengine.de/widget/ratepay/device-ident/create/ratepay-directdebit - https://pptest.payengine.de/widget/ratepay/device-ident/create/ratepay-installment

• for Production environment - - https://pp.payengine.de/widget/ratepay/device-ident/create/ratepay-invoice - https://pp.payengine.de/widget/ratepay/device-ident/create/ratepay-directdebit - https://pp.payengine.de/widget/ratepay/device-ident/create/ratepay-installment

Response of the request will contain the following properties:

• deviceIdentToken
• deviceIdentSId
• sessionToken

Example response to Create Device request can be found below:

{
		"deviceIdentToken": "a95314a9d82918657fad2b07436602bb",
		"deviceIdentSId": "ratepay",
		"sessionToken": "58c93b94b6f01ab057683125a47390fb"

__2) Loading Payengine Bridge and External Libraries of Ratepay Device Ident __

Based on the parameters received in the response of POST request in step one, the following has to be executed:

<script src="https://pp.payengine.de/bridge/1.0/payengine.min.js" type="text/javascript"> </script>

      <script type="text/javascript">
        window.onload = function() {

3) Sending Device Ident Token to Create Transaction Endpoint

Device Ident Token has to be sent via POST method in the body of Create Authorizing Transaction (Preauth or Debit) request.

It will be placed within Payment object in the field riskIdentId as shown below:

{
      ...
      payment: {
      riskIdentId: "DEVICE_IDENT_TOKEN"

Input Parameters for Authorizing Transactions

The following input parameters are required for initiating a payment via Payengine Widget:

Specific Response Parameters for Authorizing Transactions

Payengine sends the following response parameter, which is used by the merchant to trail customer money transfers:

Input Parameters for Update Order Transaction

The update order transaction is used to update a preauth transaction that has not been captured yet.

Preauth transactions can be updated through the PATCH/orders/{orderId}/transactions/{transactionId} endpoint.

Request and response samples for update order transaction can be found below.

Samples

Preauth transaction

POST/orders/preauth

{
    "terms": 1468590412476,
    "privacy": 1468590412476,
    "product": "ratepay-invoice",

{
    "createdAt": 1550657256193,
    "modifiedAt": 1550657256198,
    "merchantId": "Merchant-11111111-1111-1111-1111-111111111111",

Capture transaction

POST/orders/{orderId}/transactions/{transactionId}/capture

{
    "description": "description for opeation.",
    "currency": "EUR",
    "initialAmount": 20000,

{
    "createdAt": 1550473868193,
    "modifiedAt": 1550473869145,
    "type": "CAPTURE",

Cancel transaction

POST/orders/{orderId}/transactions/{transactionId}/cancel

{
    "initialAmount": 20000,
    "currency": "EUR",
    "description": "string",

{
    "createdAt": 1550473938975,
    "modifiedAt": 1550473939922,
    "type": "CANCEL",

Debit transaction

POST/orders/debit

{
    "terms": 1468590412476,
    "privacy": 1468590412476,
    "product": "ratepay-invoice",

{
    "createdAt": 1550657294081,
    "modifiedAt": 1550657294105,
    "merchantId": "Merchant-11111111-1111-1111-1111-111111111111",

Refund transaction

POST/orders/{orderId}/transactions/{transactionId}/refund

{
    "description": "description for operation.",
    "initialAmount": 20000,
    "currency": "EUR",

{
    "createdAt": 1550474048671,
    "modifiedAt": 1550474049591,
    "type": "REFUND",

Testing

Ratepay - Invoice can be tested via the Ratepay Sandbox.

The Ratepay Sandbox is a self-contained virtual testing environment that mimics the live Ratepay production environment.

Test data for Ratepay Sandbox can be found below:

Accept:

City: Testhausen Streetname contains: Nicht Versenden DE : the postal code should be 5 digits CH & AT : the postal code should be 4 digits NL : A postal code in the Netherlands consists of four numbers followed by two capital letters (e.g 1011AB) DE IBAN : DE15111111111111111199 NL IBAN : NL18ABNA0484869868 AT IBAN: AT022050302101023600

Decline:

City: Testhausen Surname: Ablehnung DE : the postal code should be 5 digits CH & AT : the postal code should be 4 digits NL : A postal code in the Netherlands consists of four numbers followed by two capital letters (e.g 1011AB)