\n <\/div>\n","url":"https:\/\/docs.adyen.com\/payment-methods\/riverty\/web-component","articleFields":{"description":"Add Riverty to your Components integration.","never_cache_twig":true,"parameters":{"tx_variant":"riverty","component_class_name":"Riverty","component_class_lowercase":"riverty","integration":"Components","pm_directory":"riverty","payment_method":"Riverty","action_type":"
redirect<\/strong>"},"filters_component":true,"filters_config_folder":"payment-methods\/riverty\/web\/component-web"},"algolia":[{"url":"https:\/\/docs.adyen.com\/payment-methods\/riverty\/web-component","title":"Riverty Web Component","content":"Requirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have an existing Sessions flow Web Components integration.\n\n\n\nCheckout API\nMake sure that you use Checkout API v68 or later.\n \n\n\nRedirect handling\nMake sure that your existing integration is set up to handle the redirect. action.type: redirect\n\n\n\nSetup steps\n Before you begin, add Riverty in your Customer Area. \n\n\n\n\nActivating Riverty defaults the pricing to our standard pricing. Adyen offers Enterprise pricing for merchants with sufficient volume. Before activating Riverty, contact your account manager to verify if you are eligible.\nAdd additional parameters to your \/sessions request\nWhen you create a payment session, add the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nshopperName.firstName\n\nShopper's first name. (B2B payments are currently not supported. Providing a business name here may result in a rejection.)\n\n\nshopperName.lastName\n\nShopper's last name. (B2B payments are currently not supported. Providing a business name here may result in a rejection.)\n\n\ntelephoneNumber\n\nShopper's telephone number.\n\n\nshopperEmail\n\nShopper's email address.\n\n\nbillingAddress\n\nShopper's billing address.\n\n\ndeliveryAddress\n\nShopper's delivery address.\n\n\nlineItems\n\nPrice and product information about the purchased items. This is included on the invoice that Riverty sends to the shopper. Required values for each lineItem: quantity, description and id. If you operate in a DACH country, the VAT must not be null to support the VAT reclaim process in cases of uncollectible debt. Riverty reverts the VAT from your settlement (visible as PaymentCost - see journal types) and sends you a monthly overview via email with all affected transactions, VAT amounts and instructions to claim back the VAT amounts.\n\n\ndateOfBirth\n\nShopper's date of birth, in the following format: YYYY-MM-DD\n\n\nshopperIP\n\nThe shopper's IP address. Riverty uses this for risk checks.\n\n\n\n\n \n\nImport Riverty\nWhen you import Adyen Web, include Riverty.\n\n \nAdd additional configuration for Riverty\nYou do not need to add any configuration parameters for Riverty.\nInitialize the Component for Riverty\nTo initialize Riverty, use the Riverty class.\n\n \n\nCapture the payment\nAfter 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.\nIf you do not manually capture the payment within 30 days, the authorization will expire. If you require a longer period before authorizations expire, contact our Support Team. They will inform you when Riverty has updated the expiration period for you.\nPartial captures\nTo partially capture a Riverty payment, specify in your \/payments\/{paymentPspReference}\/captures request:\n\n\n\nParameter\nDescription\n\n\n\n\namount\nThe amount that the shopper should pay.\n\n\nlineItems\nPrice 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.\n\n\n\nOnly specify the items that you are capturing. Any unclaimed amount that is left after partially capturing a payment should be manually cancelled.\n\nTo set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture.\n\nThe following example shows how to make a partial capture request if the shopper only kept item #1 of the order.\n\n \n\nThe following response is returned:\n\n \n\nManually cancel any amount that remains after partially capturing a payment.\nIf a part of the authorized amount has been captured, simply sending an empty \/payments\/{paymentPspReference}\/cancels request releases the remaining balance (without having to specify the lineItems remaining that need to be canceled).\n\n \n\n\nTo set up multiple partial captures, contact our Support Team.\u00a0Multiple partial captures will create\u00a0a new invoice for each capture.\u00a0\nRefunds and cancellations\nIf 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.\nAs with captures, you don\u2019t 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:\n\n\n\nParameter\nDescription\n\n\n\n\namount\nThe amount that is refunded to the shopper.\n\n\nlineItems\nPrice 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.\n\n\ncapturePspReference\nSpecify which capture needs to be refunded when doing partial refunds. If not specified, the last capture will be chosen automatically, whether that was the intended capture to be refunded or not.\n\n\n\nOnly specify the items that you are refunding the money for.\nThe following example shows how to make a partial refund for item #1 of the above order.\n\n \n\nThe following response is returned:\n\n \n\n\nThe pspReference in the response is the reference of the refund itself.\nTest and go live\nRiverty 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.\nGo-live requirements\nRiverty 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.","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Riverty","lvl3":"Riverty Web Component"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/payment-methods\/riverty","lvl3":"\/payment-methods\/riverty\/web-component"},"levels":4,"category":"Payment method","category_color":"green","tags":["Riverty","Component"]},{"url":"https:\/\/docs.adyen.com\/payment-methods\/riverty\/web-component?flow=Sessions flow&integration=Component","title":"Sessions flow Component","content":"Requirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have an existing Sessions flow Web Components integration.\n\n\n\nCheckout API\nMake sure that you use Checkout API v68 or later.\n \n\n\nRedirect handling\nMake sure that your existing integration is set up to handle the redirect. action.type: redirect\n\n\n\nSetup steps\n Before you begin, add Riverty in your Customer Area. \n\n\n\n\nActivating Riverty defaults the pricing to our standard pricing. Adyen offers Enterprise pricing for merchants with sufficient volume. Before activating Riverty, contact your account manager to verify if you are eligible.\nAdd additional parameters to your \/sessions request\nWhen you create a payment session, add the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nshopperName.firstName\n\nShopper's first name. (B2B payments are currently not supported. Providing a business name here may result in a rejection.)\n\n\nshopperName.lastName\n\nShopper's last name. (B2B payments are currently not supported. Providing a business name here may result in a rejection.)\n\n\ntelephoneNumber\n\nShopper's telephone number.\n\n\nshopperEmail\n\nShopper's email address.\n\n\nbillingAddress\n\nShopper's billing address.\n\n\ndeliveryAddress\n\nShopper's delivery address.\n\n\nlineItems\n\nPrice and product information about the purchased items. This is included on the invoice that Riverty sends to the shopper. Required values for each lineItem: quantity, description and id. If you operate in a DACH country, the VAT must not be null to support the VAT reclaim process in cases of uncollectible debt. Riverty reverts the VAT from your settlement (visible as PaymentCost - see journal types) and sends you a monthly overview via email with all affected transactions, VAT amounts and instructions to claim back the VAT amounts.\n\n\ndateOfBirth\n\nShopper's date of birth, in the following format: YYYY-MM-DD\n\n\nshopperIP\n\nThe shopper's IP address. Riverty uses this for risk checks.\n\n\n\n\n \n\nImport Riverty\nWhen you import Adyen Web, include Riverty.\n\n \nAdd additional configuration for Riverty\nYou do not need to add any configuration parameters for Riverty.\nInitialize the Component for Riverty\nTo initialize Riverty, use the Riverty class.\n\n \n\nCapture the payment\nAfter 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.\nIf you do not manually capture the payment within 30 days, the authorization will expire. If you require a longer period before authorizations expire, contact our Support Team. They will inform you when Riverty has updated the expiration period for you.\nPartial captures\nTo partially capture a Riverty payment, specify in your \/payments\/{paymentPspReference}\/captures request:\n\n\n\nParameter\nDescription\n\n\n\n\namount\nThe amount that the shopper should pay.\n\n\nlineItems\nPrice 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.\n\n\n\nOnly specify the items that you are capturing. Any unclaimed amount that is left after partially capturing a payment should be manually cancelled.\n\nTo set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture.\n\nThe following example shows how to make a partial capture request if the shopper only kept item #1 of the order.\n\n \n\nThe following response is returned:\n\n \n\nManually cancel any amount that remains after partially capturing a payment.\nIf a part of the authorized amount has been captured, simply sending an empty \/payments\/{paymentPspReference}\/cancels request releases the remaining balance (without having to specify the lineItems remaining that need to be canceled).\n\n \n\n\nTo set up multiple partial captures, contact our Support Team.\u00a0Multiple partial captures will create\u00a0a new invoice for each capture.\u00a0\nRefunds and cancellations\nIf 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.\nAs with captures, you don\u2019t 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:\n\n\n\nParameter\nDescription\n\n\n\n\namount\nThe amount that is refunded to the shopper.\n\n\nlineItems\nPrice 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.\n\n\ncapturePspReference\nSpecify which capture needs to be refunded when doing partial refunds. If not specified, the last capture will be chosen automatically, whether that was the intended capture to be refunded or not.\n\n\n\nOnly specify the items that you are refunding the money for.\nThe following example shows how to make a partial refund for item #1 of the above order.\n\n \n\nThe following response is returned:\n\n \n\n\nThe pspReference in the response is the reference of the refund itself.\nTest and go live\nRiverty 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.\nGo-live requirements\nRiverty 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.","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Riverty","lvl3":"Riverty Web Component"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/payment-methods\/riverty","lvl3":"\/payment-methods\/riverty\/web-component"},"levels":4,"category":"Payment method","category_color":"green","tags":["Sessions flow","Component"]},{"url":"https:\/\/docs.adyen.com\/payment-methods\/riverty\/web-component?flow=Advanced flow&integration=Component","title":"Advanced flow Component","content":"Requirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have an existing Advanced flow Web Components integration.\n \n\n\nRedirect handling\nMake sure that your existing integration is set up to handle the redirect. action.type: redirect.\n\n\n\nSetup steps\n Before you begin, add Riverty in your Customer Area. \n\n\n\n\nActivating Riverty defaults the pricing to our standard pricing. Adyen offers Enterprise pricing for merchants with sufficient volume. Before activating Riverty, contact your account manager to verify if you are eligible.\n\nHow it works\nThe following is the process to make a Riverty payment.\n\nCollect your shopper's details and specify these in your \/payments request.\nWhen you make the \/payments request, include the following information.\n\nThe shopper's details that you collected.\nThe details of the items, in the lineItems object.\nOptional: if you use profile tracking from Riverty to calculate the profile tracking ID, include deviceFingerprint.\n\nCapture the payment after the goods are sent. This triggers the invoice that the merchant sends to the shopper.\n\nProfile tracking\nProfile tracking is Riverty's technology for risk evaluation of shoppers. For payments in the following countries, we recommend that you use it to improve acceptance.\n\nAustria\nGermany\nSwitzerland\n\nYou must get the \n profileTrackingShopId\n from Riverty\u2019s implementation support team before implementing profile tracking.\nTo integrate with profile tracking, you can implement the script from Riverty. It calculates a profile tracking ID for each shopper. The script collects data about the shopper\u2019s device (profile tracking ID) to predict scripted attacks.\n\nWhen the shopper goes to the checkout page, run the script. It outputs a profile tracking ID.\nEncrypt the profile tracking ID in a string.\nWhen you make the \/payments request, include the encrypted string in deviceFingerprint. We recommend you always include this.\nGet Riverty as an available payment method\nWhen you make the \/paymentMethods to get available payment methods, specify the following so that Riverty is included in the response.\n\n\n\nParameter\nPossible values\n\n\n\n\n countryCode\nAT, BE, DE, NL, CH\n\n\n amount.currency\nEUR, CHF\n\n\n\n\n \n\nThe response includes paymentMethod.type: riverty.\n\n \nImport Riverty\nWhen you import Adyen Web, include Riverty.\n\n \nAdd additional configuration for Riverty\nYou do not need to add any configuration parameters for Riverty.\nInitialize the Component for Riverty\nTo initialize Riverty, use the Riverty class.\n\n \n\nAdd additional parameters to your \/payments request\nWhen you make a payment, add the following parameters to the \/payments request:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\npaymentMethod.type\n\nThe type of Riverty payment. Possible values: - riverty: Pay in 14. - riverty_account: Monthly Consolidated Invoice. - sepadirectdebit_riverty: Secure Direct Debit - riverty_installments: Pay in fixed installments of 3, 6, 12, or 24 months\n\n\npaymentMethod.subtype\n\nredirect\n\n\n billingAddress\n\nThe address where to send the invoice.\n\n\n deliveryAddress\n\nThe address where the purchased goods should be delivered. Only send deliveryAddress if either the address and\/or the \"delivery person\" deviate from the billing address. When sending deliveryAddress , the deliveryAddress.firstName and deliveryAddress.lastname are required, even if the person is the same as shopperName.firstName and shopperName.lastName. This helps to identify whoever will be accepting the delivery. Note: If the shopper is using Riverty for the first time, the payment can be rejected for risk reasons if deliveryAddress is different from billingAddress. In that case, only send billingAddress. The shopper is expected to receive the package there.\n\n\n shopperName.firstName\n\nShopper's first name. (B2B payments are currently not supported. Providing a business name here may result in a rejection.)\n\n\n shopperName.lastName\n\nShopper's last name. (B2B payments are currently not supported. Providing a business name here may result in a rejection.)\n\n\n telephoneNumber\n\nShopper's telephone number.\n\n\n shopperEmail\n\nShopper's email address.\n\n\n lineItems\n\nPrice and product information about the purchased items. This is included on the invoice that Riverty sends to the shopper. Required values for each lineItem: quantity, description and id. If you operate in a DACH country, the VAT must not be null to support the VAT reclaim process in cases of uncollectible debt. Riverty reverts the VAT from your settlement (visible as PaymentCost - see journal types) and sends you a monthly overview via email with all affected transactions, VAT amounts and instructions to claim back the VAT amounts.\n\n\npaymentMethod.iban\nRequired for paymentMethod.type: sepadirectdebit_riverty.\nThe IBAN of the shopper.\n\n\npaymentMethod.deviceFingerprint\n\nA string containing the shopper's calculated profile tracking ID.\n\n\n dateOfBirth\n\nShopper's date of birth, in the following format: YYYY-MM-DD\n\n\n shopperIP\n\nThe shopper's IP address. Riverty uses this for risk checks.\n\n\n\n\n \n\nThe response includes action.type: redirect.\n\n \n\nCapture the payment\nAfter 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.\nIf you do not manually capture the payment within 30 days, the authorization will expire. If you require a longer period before authorizations expire, contact our Support Team. They will inform you when Riverty has updated the expiration period for you.\nPartial captures\nTo partially capture a Riverty payment, specify in your \/payments\/{paymentPspReference}\/captures request:\n\n\n\nParameter\nDescription\n\n\n\n\namount\nThe amount that the shopper should pay.\n\n\nlineItems\nPrice 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.\n\n\n\nOnly specify the items that you are capturing. Any unclaimed amount that is left after partially capturing a payment should be manually cancelled.\n\nTo set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture.\n\nThe following example shows how to make a partial capture request if the shopper only kept item #1 of the order.\n\n \n\nThe following response is returned:\n\n \n\nManually cancel any amount that remains after partially capturing a payment.\nIf a part of the authorized amount has been captured, simply sending an empty \/payments\/{paymentPspReference}\/cancels request releases the remaining balance (without having to specify the lineItems remaining that need to be canceled).\n\n \n\n\nTo set up multiple partial captures, contact our Support Team.\u00a0Multiple partial captures will create\u00a0a new invoice for each capture.\u00a0\nRefunds and cancellations\nIf 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.\nAs with captures, you don\u2019t 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:\n\n\n\nParameter\nDescription\n\n\n\n\namount\nThe amount that is refunded to the shopper.\n\n\nlineItems\nPrice 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.\n\n\ncapturePspReference\nSpecify which capture needs to be refunded when doing partial refunds. If not specified, the last capture will be chosen automatically, whether that was the intended capture to be refunded or not.\n\n\n\nOnly specify the items that you are refunding the money for.\nThe following example shows how to make a partial refund for item #1 of the above order.\n\n \n\nThe following response is returned:\n\n \n\n\nThe pspReference in the response is the reference of the refund itself.\nTest and go live\nRiverty 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.\nGo-live requirements\nRiverty 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.","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Riverty","lvl3":"Riverty Web Component"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/payment-methods\/riverty","lvl3":"\/payment-methods\/riverty\/web-component"},"levels":4,"category":"Payment method","category_color":"green","tags":["Advanced flow","Component"]}],"articleFiles":{"payment-methods-response.json":"payment-methods-response.json<\/p>","payments-response.json":"
payments-response.json<\/p>"}}