Introduction

The Riverty APM enables customers in a number of European countries to use their local bank account and currency to make direct debit payments (deposits), to buy now and pay within 14 days, or to pay in monthly installments.

Supported Countries

• Austria
• Belgium
• Denmark
• Finland
• Germany
• Netherlands
• Norway
• Sweden
• Switzerland

Supported Currencies

• CHF
• DKK
• EUR
• NOK
• SEK

Payment (Deposit) Flow

Use this flow for direct debit payment – a one-time withdrawal from the user’s bank account.

Follow these steps to perform a payment using Nuvei REST API integration:

1. Generate a sessionToken

Press here for details.

2. Send a /payment Request

Perform the payment by sending a /payment request with its mandatory parameters including:

• userTokenId
• amount
• currency
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_Riverty“
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstName, lastName,  country, email
• userDetails class containing the following parameters according to country:
  
  
  

  country	DE	AT	CH	NL	BE	SE	NO	FI	DK
  identification						✔	✔	✔	✔
  firstName	✔	✔	✔	✔	✔	✔	✔	✔	✔
  lastName	✔	✔	✔	✔	✔	✔	✔	✔	✔
  email	✔	✔	✔	✔	✔	✔	✔	✔	✔
  phone				✔	✔
  dateOfBirth	✔	✔	✔	✔	✔				✔
  country	✔	✔	✔	✔	✔	✔	✔	✔	✔
  zip	✔	✔	✔	✔	✔	✔	✔	✔	✔
  address	✔	✔	✔	✔	✔	✔	✔	✔	✔
  streetNumber	✔	✔	✔	✔	✔				✔
  city	✔	✔	✔	✔	✔	✔	✔	✔	✔

You can also include an items array that contains one or more sets of these parameters:

Parameter	Mandatory
name	Yes
type	Yes
price	Yes
quantity	Yes
groupId	Yes
imageUrl	Yes
productUrl	Yes
discount	No
discountRate	No
shipping	No
shippingTax	No
shippingTaxRate	No
tax	No
taxRate	No

Example /payment Request

{
  "sessionToken": "<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "clientRequestId": "<unique request ID in merchant system>",
  "amount": "120",
  "currency": "EUR",
  "userTokenId": "<unique customer identifier in merchant system>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "paymentOption": {
    "alternativePaymentMethod": {
      "paymentMethod": "apmgw_Riverty"
    }
  },
  "deviceDetails": {
    "ipAddress": "<customer's IP address>"
  },
  "billingAddress": {
    "firstName": "John",
    "lastName": "Smith",
    "country": "DE",
    "email": "[email protected]"
  },
  "userDetails": {
    "firstName": "John",
    "lastName": "Smith",
    "country": "DE",
    "email": "[email protected]",
    "dateOfBirth": "2000-06-30",
    "zip": "10115",
    "address": "99 Am Steinbergpark",
    "streetNumber": "99",
    "city": "Berlin"
  },
  "items": [
    {
      "name": "Invictus",
      "type": "Physical",
      "price": "100",
      "quantity": "2",
      "groupId": "Perfumes",
      "discount": "0",
      "discountRate": "0",
      "shipping": "15",
      "shippingTax": "0",
      "shippingTaxRate": "0",
      "tax": "10",
      "taxRate": "10",
      "imageUrl": "https://upload.wikimedia.org/wikipedia/commons/4/47/American_Eskimo_Dog.jpg",
      "productUrl": "http://image.url.com/product.jpg"
    }
  ],
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

 

The response generates and returns a redirect URL (redirectUrl) to redirect the customer to the payment page, as well as a UPO (userPaymentOptionId) for use in future transactions.

Example /payment Response

{
  "internalRequestId": 41204851,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "5634436935940029474",
  "merchantSiteId": "242181",
  "version": "1.0",
  "sessionToken": "62e83699-475f-4155-af13-ca376836fff2",
  "clientUniqueId": "609763107525473",
  "orderId": "43128921",
  "userTokenId": "RESTx_Riverty",
  "paymentOption": {
    "redirectUrl": "https://apmtest.gate2shop.com/ppp/resources/cdn/v1/payment-details-176902.html?encryptedId=5C63512F80670D9B8D375185D5E6113D&sessionId=40441e36b1d48fd99ef37362955c&profileTrackingShopId=af6495-2162&locale=en_DE&currency=EUR&domain=https%3a%2f%2fwhm.asip.cloud&payloadUrl=https%3a%2f%2fk8s-tlv-cl0-qa1.gw-4u.com%2fapm%2friverty%2fv1%2fpayload%2f5C63512F80670D9B8D375185D5E6113D%3fsignature%3drS0pBptJzsdV1j0xtHrirjJ4jYoUCfxy2JdTUdXT9Oc%253d&postFormLandingUrl=https%3a%2f%2fk8s-tlv-cl0-qa1.gw-4u.com%2fapm%2friverty%2fv1%2fpostFormLanding&profileId=0&signature=rS0pBptJzsdV1j0xtHrirjJ4jYoUCfxy2JdTUdXT9Oc%3d",
    "userPaymentOptionId": "2153198281",
    "card": {}
  },
  "transactionStatus": "REDIRECT"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

Example Payment DMN with Status=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=43128921&userid=VRESTx_Riverty&merchant_unique_id=609763107525473&customData=&productId=&first_name=John&last_name=Doe&email=johndoe%40email.com&currency=EUR&clientUniqueId=609763107525473&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=99%2CRheinstra%C3%9Fe&address2=&country=Germany&state=&city=Verl&zip=33415&phone1=0513744112&phone2=&phone3=&client_ip=68.71.86.50&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=Riverty-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=DE&shippingState=&shippingCity=Berlin&shippingAddress=Rheinstra%C3%9Fe&shippingZip=12159&shippingFirstName=John&shippingLastName=Doe&shippingPhone=&shippingCell=&shippingMail=johndoe%40test.com&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=242181&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_Riverty&ID=&merchant_id=5634436935940029474&responseTimeStamp=2024-05-29.11%3A04%3A18&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=VRESTx_Riverty&userPaymentOptionId=2153198281&TransactionID=2610000000000029883&externalTransactionId=1803101a-6c96-4f1e-8cea-21061cbb9a5c&APMReferenceID=5C63512F80670D9B8D375185D5E6113D&orderTransactionId=24496991&totalAmount=120.00&dynamicDescriptor=static+test&item_name_1=screen+protector&item_number_1=&item_amount_1=120.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&maskedNetworkTokenNumber=&upoRegistrationDate=20240423&type=DEPOSIT&clientRequestId=&relatedTransactionId=&sessionId=40441e36b1d48fd99ef37362955c&responsechecksum=e61e9149ee850e37e954f855d631f05a&advanceResponseChecksum=2b72548b9389ba80ea7398dd8fe98e4d',

Example Payment DMN with Status=DECLINED

...'ppp_status=FAIL&Status=DECLINED&ExErrCode=0&ErrCode=1&errApmCode=1&errApmDescription=Parent+transaction+reference+is+already+used+on+the+client.&errScCode=10091&errScDescription=Strong+customer+authentication+required.&Reason=Strong+customer+authentication+required.&ReasonCode=10091&PPP_TransactionID=42319031&userid=VladRESTx_Riverty&merchant_unique_id=203400034&customData=&productId=&first_name=John&last_name=Doe&email=johndoe%40email.com&currency=EUR&clientUniqueId=203400034&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=65%2C+Overlea+str&address2=&country=Germany&state=&city=Toronto&zip=K0A+0A2&phone1=&phone2=&phone3=&client_ip=68.71.86.50&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=Riverty-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=DE&shippingState=&shippingCity=Berlin&shippingAddress=Berliner&shippingZip=10115&shippingFirstName=John&shippingLastName=Doe&shippingPhone=&shippingCell=&shippingMail=test%40test.com&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=242181&merchant_status=&action=&requestVersion=&message=DECLINED&merchantLocale=&unknownParameters=&payment_method=apmgw_Riverty&ID=&merchant_id=5634436935940029474&responseTimeStamp=2024-04-04.09%3A17%3A41&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=VladRESTx_Riverty&userPaymentOptionId=2153139311&TransactionID=2610000000000017681&APMReferenceID=11A17DA1B381D5BC3F1E0542510649BD&orderTransactionId=23749381&totalAmount=120.00&dynamicDescriptor=static+test&item_name_1=screen+protector&item_number_1=&item_amount_1=120.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&upoRegistrationDate=20240207&type=DEPOSIT&clientRequestId=&relatedTransactionId=&sessionId=865b4464beff1b6a8aee0aa66cdb&responsechecksum=c9108bd8e87558f376b02991c3bc59a6&advanceResponseChecksum=38d24c0a73800d78d854aae8e18da547',

Auth-Settle Flow

Use this flow for buy now and pay within 14 days and for monthly installment payment.

Follow these steps to perform these types of payments using Nuvei REST API integration:

1. Generate a sessionToken

Press here for details.

2. Send a /payment Request

Send a /payment request with its mandatory parameters including:

• userTokenId
• amount
• currency
• transactionType
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_Riverty“
• deviceDetails class containing: ipAddress
• billingAddress block containing: firstName, lastName,  country, email
• userDetails class containing the following parameters according to country:
  
  
  

  country	DE	AT	CH	NL	BE	SE	NO	FI	DK
  identification						✔	✔	✔	✔
  firstName	✔	✔	✔	✔	✔	✔	✔	✔	✔
  lastName	✔	✔	✔	✔	✔	✔	✔	✔	✔
  email	✔	✔	✔	✔	✔	✔	✔	✔	✔
  phone				✔	✔
  dateOfBirth	✔	✔	✔	✔	✔				✔
  country	✔	✔	✔	✔	✔	✔	✔	✔	✔
  zip	✔	✔	✔	✔	✔	✔	✔	✔	✔
  address	✔	✔	✔	✔	✔	✔	✔	✔	✔
  streetNumber	✔	✔	✔	✔	✔				✔
  city	✔	✔	✔	✔	✔	✔	✔	✔	✔

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

3. Send a /settleTransaction Request

Press here for details.

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /settleTransaction request.

Example /settleTransaction DMN with Status=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=43144401&userid=VRESTx_Riverty&merchant_unique_id=20240531155747&customData=&productId=&first_name=John&last_name=Doe&email=johndoe%40email.com&currency=EUR&clientUniqueId=20240531155747&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=99%2CRheinstra%C3%9Fe&address2=&country=Germany&state=&city=Verl&zip=33415&phone1=0513744112&phone2=&phone3=&client_ip=68.71.86.50&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=null&expMonth=&expYear=&Token=&tokenId=&AuthCode=43144401&AvsCode=&Cvv2Reply=&shippingCountry=DE&shippingState=&shippingCity=Berlin&shippingAddress=Rheinstra%C3%9Fe&shippingZip=12159&shippingFirstName=John&shippingLastName=Doe&shippingPhone=&shippingCell=&shippingMail=johndoe%40test.com&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=242181&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_Riverty&ID=&merchant_id=5634436935940029474&responseTimeStamp=2024-05-31.12%3A57%3A49&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=null&transactionType=Settle&externalEmail=&cardCompany=&user_token_id=VRESTx_Riverty&userPaymentOptionId=2153198281&TransactionID=2610000000000030790&externalTransactionId=800802864&totalAmount=120.0&dynamicDescriptor=static+test&item_name_1=screen+protector&item_number_1=&item_amount_1=120.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&maskedNetworkTokenNumber=&upoRegistrationDate=20240423&type=DEPOSIT&clientRequestId=20240531155747&relatedTransactionId=2610000000000030675&responsechecksum=3c7ef042908bbd31ffad275666ca6399&advanceResponseChecksum=f74a62544c453f6cc11287949ec9867b',

Example /settleTransaction DMN with Status=DECLINED

...'ppp_status=FAIL&Status=DECLINED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=43144401&userid=VRESTx_Riverty&merchant_unique_id=20240531160441&customData=&productId=&first_name=John&last_name=Doe&email=johndoe%40email.com&currency=EUR&clientUniqueId=20240531160441&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=99%2CRheinstra%C3%9Fe&address2=&country=Germany&state=&city=Verl&zip=33415&phone1=0513744112&phone2=&phone3=&client_ip=68.71.86.50&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=null&expMonth=&expYear=&Token=&tokenId=&AuthCode=43144401&AvsCode=&Cvv2Reply=&shippingCountry=DE&shippingState=&shippingCity=Berlin&shippingAddress=Rheinstra%C3%9Fe&shippingZip=12159&shippingFirstName=John&shippingLastName=Doe&shippingPhone=&shippingCell=&shippingMail=johndoe%40test.com&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=242181&merchant_status=&action=&requestVersion=&message=DECLINED&merchantLocale=&unknownParameters=&payment_method=apmgw_Riverty&ID=&merchant_id=5634436935940029474&responseTimeStamp=2024-05-31.13%3A04%3A42&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=null&transactionType=Settle&externalEmail=&cardCompany=&user_token_id=VRESTx_Riverty&userPaymentOptionId=2153198281&TransactionID=2610000000000030802&totalAmount=120.0&dynamicDescriptor=static+test&item_name_1=screen+protector&item_number_1=&item_amount_1=120.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&maskedNetworkTokenNumber=&upoRegistrationDate=20240423&type=DEPOSIT&clientRequestId=20240531160441&relatedTransactionId=2610000000000030675&responsechecksum=9e843f0ea8e1d741cff80d02c5d11c29&advanceResponseChecksum=ddffd8ab044c63634fd3fad0f307ffdc',

User Experience

1. The user is redirected and selects a payment option.
   Invoice – 14 days
   
   Direct debit
   The user enters the IBAN.
   
   Installment with Direct debit
   The user selects an installment plan and enters the IBAN.
   
2. The user agrees to the terms and conditions, and confirms the payment.
3. After the payment is completed, a confirmation message appears.
   

Testing

Test credentials and testing scenarios can be provided by Nuvei if necessary. You can contact Nuvei support for assistance.