{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","tabs","tab"]},"type":"markdown"},"seo":{"title":"Welcome","description":"The specifications of Ratepay's APIs for easy payment transactions.","siteUrl":"https://docs.ratepay.com","keywords":"Ratepay developer portal, Ratepay api portal, Ratepay api reference docs","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"welcome-to-the-ratepay-documentation-portal","__idx":0},"children":["Welcome to the Ratepay documentation portal"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"badges-container"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"reading-time-badge"},"children":["⏱ 1 min"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"author-badge"},"children":["👤 Merchant Onboarding Team (Marcel K.)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ratepay is a white-label Buy Now, Pay Later (BNPL) payment solution."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With Ratepay payment methods, transaction security is handled by Ratepay, including full credit risk assumption and end-to-end payment processing."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"new-to-ratepay","__idx":1},"children":["New to Ratepay?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you're evaluating Ratepay or looking for an overview, we would recommend to start with ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/about_ratepay/payment_methods"},"children":["Payment methods"]}," to understand how Ratepay works before exploring integration or operational details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getting-started","__idx":2},"children":["Getting started"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Developer","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":6,"id":"technical-details-for-integrating-ratepay-directly-into-your-checkout-or-backend-systems","__idx":3},"children":["Technical details for integrating Ratepay directly into your checkout or backend systems."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-grid"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/integration_options"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Integration options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start by identifying which integration approach matches your use cases."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Continue"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-grid"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/api_integration/payment_2.0/payment_api_2.0"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Payment API 2.0"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our latest API for new integrations, offering improved flexibility."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]},{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/hosted_payment_page/introduction"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Hosted Payment Page"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A redirect-based integration where Ratepay hosts the payment experience for you."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]},{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/api_integration/payment_1.8/payment_1.8"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Payment API 1.8"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The previous generation of the Ratepay Payment API, still supported for existing integrations."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"shop-systems","__idx":4},"children":["Shop Systems"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":6,"id":"ready-made-plugins-for-popular-e-commerce-platforms-to-get-started-quickly","__idx":5},"children":["Ready-made plugins for popular e-commerce platforms to get started quickly."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-grid"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/shop_modules/shopware/overview"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Shopware"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Official Ratepay plugin for integrating BNPL payment methods into Shopware."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]},{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/shop_modules/magento/overview"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Magento"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Integrate the Ratepay payment methods into your Magento-based webshop."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]},{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/shop_modules/oxid/overview"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["OXID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enable Ratepay in your OXID eShop."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"payment-service-providers","__idx":6},"children":["Payment Service Providers"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":6,"id":"integrations-with-supported-payment-service-providers-that-already-include-ratepay","__idx":7},"children":["Integrations with supported payment service providers that already include Ratepay."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-grid"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/psps_and_marketplaces/adyen/ratepay_docs"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Adyen"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Ratepay through your existing Adyen integration."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]},{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/psps_and_marketplaces/avarda/ratepay_docs"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Avarda"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Integrate Ratepay via Avarda."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]},{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/developer/psps_and_marketplaces/payone/ratepay_docs"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["PAYONE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Process Ratepay payments via PAYONE."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Customer Service","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":6,"id":"tools-and-documentation-for-managing-transactions-customers-and-day-to-day-operations","__idx":8},"children":["Tools and documentation for managing transactions, customers, and day-to-day operations."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-grid"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/orca/english_version/welcome_to_orca"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-icon"},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/orca.3279fbad928f73679bef9fb7080e2dd85de72256518a34a5d828fefe556cd2f1.9c1bb791.png"},"children":[]}]},{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["ORCA"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Ratepay merchant portal for transaction management, customer support, and reporting."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Finance","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":6,"id":"documentation-for-payouts-reconciliation-and-financial-reporting","__idx":9},"children":["Documentation for payouts, reconciliation, and financial reporting."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-grid"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/reporting/settlement/overview"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Settlement Files"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Detailed information about your payouts and transferred amounts."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]},{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/reporting/clearing/clearing_files"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Clearing Files"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Daily transaction-level data for reconciliation and accounting purposes."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]},{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/reporting/merchant_invoice/merchant_invoice"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Merchant Invoices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Monthly invoices covering fees and services provided by Ratepay."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Legal","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":6,"id":"legal-and-compliance-requirements-for-offering-ratepay-payment-methods-in-your-shop","__idx":10},"children":["Legal and compliance requirements for offering Ratepay payment methods in your shop."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-grid"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"className":"card","href":"/docs/legal/a_legal_requirements_for_the_integration/basic_integration"},"children":[{"$$mdtype":"Tag","name":"h3","attributes":{},"children":["Basic integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Legal guidelines and mandatory requirements for integrating Ratepay into your shop."]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-cta"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"card-footer"},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"card-link"},"children":["Read docs"]},{"$$mdtype":"Tag","name":"span","attributes":{"className":"arrow-button"},"children":["→"]}]}]}]}]}]}]}]},"headings":[{"value":"Welcome to the Ratepay documentation portal","id":"welcome-to-the-ratepay-documentation-portal","depth":1},{"value":"New to Ratepay?","id":"new-to-ratepay","depth":2},{"value":"Getting started","id":"getting-started","depth":2},{"value":"Technical details for integrating Ratepay directly into your checkout or backend systems.","id":"technical-details-for-integrating-ratepay-directly-into-your-checkout-or-backend-systems","depth":6},{"value":"Shop Systems","id":"shop-systems","depth":4},{"value":"Ready-made plugins for popular e-commerce platforms to get started quickly.","id":"ready-made-plugins-for-popular-e-commerce-platforms-to-get-started-quickly","depth":6},{"value":"Payment Service Providers","id":"payment-service-providers","depth":4},{"value":"Integrations with supported payment service providers that already include Ratepay.","id":"integrations-with-supported-payment-service-providers-that-already-include-ratepay","depth":6},{"value":"Tools and documentation for managing transactions, customers, and day-to-day operations.","id":"tools-and-documentation-for-managing-transactions-customers-and-day-to-day-operations","depth":6},{"value":"Documentation for payouts, reconciliation, and financial reporting.","id":"documentation-for-payouts-reconciliation-and-financial-reporting","depth":6},{"value":"Legal and compliance requirements for offering Ratepay payment methods in your shop.","id":"legal-and-compliance-requirements-for-offering-ratepay-payment-methods-in-your-shop","depth":6}],"frontmatter":{"seo":{"title":"Welcome"}},"lastModified":"2026-03-13T16:27:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}