Ratepay Drop-in integration

Our Web Drop-in renders Ratepay in your payment form, and collects the required payment information from the shopper.

When making a Ratepay payment, you also need to:

1. Collect shopper details, and specify these in your payment request.
2. Provide information about the purchased items by specifying lineItems in your payment request.
3. Using Ratepay's device fingerprinting, calculate the shopper's device fingerprint, and specify it in your payment request. Ratepay uses the fingerprint for risk evaluation.
4. Capture the payment after the goods have been sent. This triggers the invoice to be sent to the shopper by the merchant.

Requirements

Import resources for v6

If you are using Web Drop-in v6, import the resources you need for Ratepay:

import { AdyenCheckout, RatePay} from '@adyen/adyen-web'

Show Ratepay in your payment form

Drop-in uses the countryCode and the amount.currency from the /paymentMethods request to show the available payment methods to your shopper.

To show Ratepay in your payment form, specify in your /paymentMethods request one of the following combinations:

The response contains supported payment method types:

Optional Drop-in configuration

When creating an instance of Drop-in, you can optionally configure the visibility of the shopper input fields for Ratepay:

• personalDetails: Shopper name, date of birth, phone number, and email address.
• billingAddress: The address where to send the invoice.
• deliveryAddress: The address where the purchased goods should be delivered.

Here's an example of creating an instance of Drop-in with various configuration options.

const dropin = checkout
    .create('dropin', {
        paymentMethodsConfiguration: {
            ratepay: { // Optional configuration for Ratepay Open Invoice
                visibility: {
                    personalDetails: "hidden", // These fields will not appear on the payment form.
                    billingAddress: "readOnly", // These fields will appear on the payment form,
                                              //but the shopper cannot edit them.
                    deliveryAddress: "editable" //These fields will appear on the payment form,
                                              // and the shopper can edit them.
                                              //This is the default behavior.
                }
            }
        }
    })
    .mount('#dropin');

Calculate the device fingerprint

Before making a payment you need to implement Ratepay's device fingerprinting. Send the calculated device fingerprint when making a /payments request.

Make a payment

When the shopper selects to pay, Drop-in calls the onSubmit event, which contains a state.data.

1. Pass the state.data to your server.

2. From your server, make a /payments request with the following data:

The /payments response contains:

• (Only for Open Invoice payments) additionalData.openinvoicedata.descriptor: The purpose of the payment which you should print on the invoice. The shopper provides it when making a bank transfer, so Ratepay can match the payment to the transaction.
• resultCode: Use this to present the payment result to your shopper.
• pspReference: Our unique reference for the payment.
• merchantReference: Your reference from the /payments request.

Present the payment result

Use the  resultCode that you received in the /payments response to present the payment result to your shopper.

The resultCode values you can receive for Ratepay are:

Capture the payment

This section only applies to Ratepay Open invoice.

After the goods have been sent, you also need to capture the payment. All Ratepay Open invoice payments must be manually captured, even if you have enabled automatic capture for other payment methods. Capturing the payment is what triggers the invoice to be sent to the shopper.

Partial captures

To partially capture a Ratepay Open invoice payment, specify in your /capture request:

• modificationAmount: The amount that the shopper should pay. 
• additionalData.openinvoicedata: Price and product information for the items that the shopper should pay for.

Although the field names are different, the information in additionalData.openinvoicedata is the same as what you provided in lineItems when making a /payments request:

The following example shows how to make a partial capture request if the shopper only kept one pair of socks from the two included in the original payment request.

Any unclaimed amount that is left after partially capturing a payment should be manually cancelled.

Refunds and cancellations

If a Ratepay payment has not yet been captured, you can cancel it. If the Ratepay payment has already been captured and you want to return the funds to the shopper, you need to refund it.

Partial refunds

To partially refund a Ratepay payment, specify in your /payments/{paymentPspReference}/refunds request:

• modificationAmount: The amount to be refunded to the shopper.
• additionalData.acquirerReference: The acquirerReference of the capture. This is needed if there are multiple partial captures available for the payment. When refunding in your Customer Area, you can add the acquirerReference manually as well.
• (Only for Open invoice payments)additionalData.openinvoicedata: Price and product information about the returned items.

Although the field names are different, the information in additionalData.openinvoicedata is the same as what you provided in lineItems when making a /payments request:

The following example shows how to make a partial refund request if the shopper returned the shoes included in the original payment request.

Test and go live

Before you can accept live Ratepay payments, you need to submit a request for Ratepay in your live Customer Area, and provide us your Ratepay live credentials.

Ratepay provides detailed error codes as well as test data and recommendations on how to test some of the most common scenarios.

You can check the status of the test payments in your Customer Area > Transactions > Payments.

See also