Accept Riverty payments using an existing API only integration.
Before you begin
Before starting your Riverty integration:
- Make sure that you have done the API integration.
- Add Riverty in your test Customer Area.
Build your payment form for Riverty
To show Riverty in your payment form, specify one of the following combinations in your /paymentMethods request:
| Country | countryCode |
amount.currency |
|---|---|---|
| Germany | DE | EUR |
| Austria | AT | EUR |
| Switzerland | CH | CHF |
To make a Riverty payment, you need to collect the following shopper details:
| Name | Description |
|---|---|
firstName |
Shopper's first name. |
lastName |
Shopper's last name. |
dateOfBirth |
Shopper's date of birth. |
telephoneNumber |
Shopper's phone number. |
shopperEmail |
Shopper's email address. |
billingAddress |
The address where to send the invoice. |
deliveryAddress |
The address where the purchased goods should be delivered. |
We provide a Riverty logo which you can use in your payment form. For more information, refer to Downloading logos.
Make a payment
Riverty uses profile tracking technology to detect and recognize internet access devices (e.g. PCs, smartphones, tablets, etc.) and to identify possible fraud attempts on your websites. Before making a payment you need to implement Riverty’s profile tracking integration. Send the calculated profile tracking ID when making a /payments request.
You need a Riverty client ID for the profile tracking integration. Get this client ID from your Adyen contact person or by reaching out to support@adyen.com.
From your server, make a /payments request:
| Parameter | Required | Description |
|---|---|---|
| paymentMethod.type |  |
riverty |
| paymentMethod.deviceFingerprint | |
A string containing the shopper's calculated profile tracking ID |
| shopperName.firstName | |
Shopper's first name. |
| shopperName.lastName | |
Shopper's last name. |
| telephoneNumber | |
Shopper's telephone number. |
| shopperEmail | |
Shopper's email address. |
| dateOfBirth | |
Shopper's date of birth, in format: YYYY-MM-DD |
| shopperIP | |
The shopper's IP address. Riverty uses this for risk checks. |
| billingAddress | |
The address where to send the invoice. |
| deliveryAddress | |
The address where the purchased goods should be delivered. |
| lineItems | |
Price and product information about the purchased items. This is included on the invoice that Riverty sends to the shopper. |
The /payments response contains:
| Parameter | Description |
|---|---|
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 Riverty are:
| resultCode | Description | Action to take |
|---|---|---|
| Authorised | The payment was successfully authorised. | Inform the shopper that the payment was successful. After the goods have been sent, you also need to capture the payment. |
| Refused | The payment was refused by Riverty. | Ask the shopper to try the payment again using a different payment method. |
Capture the payment
After the goods have been sent, you also need to capture the payment. All Riverty 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 and starts the payment schedule.
Partial captures
To partially capture a Riverty payment, specify in your /payments/{paymentPspReference}/captures request:
| Parameter | Description |
|---|---|
amount |
The amount that the shopper should pay. |
lineItems |
Price and product information for the items that the shopper should pay for. You only need to specify lineItems if you are sending a partial capture, not if you are sending a full capture. The sum of the lineItems must match the amount declared in the capture call, otherwise Adyen will add a dummy lineItems entry to account for the difference. |
Only specify the items that you are capturing.
The following example shows how to make a partial capture request if the shopper only kept item #1 of the order.
The following response is returned:
Manually cancel any amount that remains after partially capturing a payment.
To set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture.
Refunds and cancellations
If you have not captured a Riverty payment, you can cancel it. If you have captured the payment and you want to return the funds to the shopper, you need to refund it.
As with captures, you don’t need to specify lineItems in the refund request if you are doing a full refund. To partially refund a Riverty payment, specify in your /payments/{paymentPspReference}/refunds request:
| Parameter | Description |
|---|---|
amount |
The amount that is refunded to the shopper. |
lineItems |
Price and product information for the items that the shopper should pay for. The sum of the lineItems needs to match the amount declared in the refund call. If they do not match, Adyen will add a dummy lineItem entry to account for the difference. |
Only specify the items that you are refunding the money for.
The following example shows how to make a partial refund for item #1 of the above order.
The following response is returned:
The pspReference is specifically for the refund transaction, not for the original payment.
Test and go live
To test Riverty, submit a request to add Riverty in your test Customer Area.
Riverty provides detailed error codes, recommendations on how to test some of the most common scenarios as well as a comprehensive list of market specific test data.
Go-live requirements
Riverty requires you to display Terms & Conditions as well as data protection guidelines in your checkout for the shopper to approve before making the payment. See Riverty's documentation for details.