# Embed Documentation

## Docs

- Embed Documentation (https://docs.embed.co/) The Embed documentation page provides an overview of tools and resources for integrating modern payment infrastructure into software platforms, enabling users to create seamless embedded payment experiences, manage operations, and explore APIs. It includes guides, onboarding materials, and options to get started or request a sandbox environment.
- Acquirer Response Codes (https://docs.embed.co/accept-payments/acquirer-response-codes) The "Acquirer Response Codes" documentation page provides a comprehensive list of response codes related to payment transactions, enabling readers to understand the implications of each code, such as transaction approval or decline reasons, and the necessary actions to take based on these responses. This understanding is crucial for managing payment processing effectively and addressing issues like insufficient funds or invalid transactions.
- Availability of funds (https://docs.embed.co/accept-payments/availability-of-funds) The "Availability of Funds" documentation page explains the processing periods for transactions, detailing how long it takes for funds to become available for payout after capture, influenced by payment method provider delays and Embed's internal processing. It also outlines the payout schedule options (weekly or monthly) and factors that may affect the timing, such as weekends, public holidays, and unforeseen delays.
- Checkout statuses (https://docs.embed.co/accept-payments/checkout-statuses) The "Checkout statuses" documentation page provides an overview of the different statuses a Checkout can have, detailing how to retrieve the current status using specific API endpoints and explaining the implications of each status for both the shopper and the merchant. It also outlines how to handle expired Checkouts, emphasizing the importance of the `expiresAt` field for determining expiration.
- Handling of payment results (https://docs.embed.co/accept-payments/handle-payment-results-overview) This documentation page provides guidance on handling payment results for merchants, detailing how to manage different payment methods, retry failed payments, and understand various payment statuses. It emphasizes the importance of setting up payment notifications and storing Checkout IDs for effective payment processing and redirection management.
- Handle payment results (https://docs.embed.co/accept-payments/handling-payment-results) This documentation page provides guidance on handling various outcomes and statuses of Merchant payments, including an overview of payment results and detailed explanations of acquirer response codes, enabling readers to implement effective error handling in payment processing.
- In-person Payments (https://docs.embed.co/accept-payments/in-person-payments) The "In-person Payments" documentation page provides an overview of Embed's POS solution, detailing supported payment terminals and integration methods, enabling businesses to seamlessly accept payments through their existing systems or by adopting a fully integrated solution. It highlights key features of the Apollo and ApolloMax terminals, along with upcoming support for additional terminals and integration options.
- Merchant Category Codes (MCC) (https://docs.embed.co/accept-payments/merchant-category-codes) This documentation page provides a list of approved Merchant Category Codes (MCC) for accepting card payments, along with instructions for merchants whose codes are not listed to request their addition.
- Notifications (https://docs.embed.co/accept-payments/notifications) The "Notifications" documentation page provides guidance on integrating webhook notifications to receive real-time updates on key events, such as transaction statuses and payment changes. It details the setup process for webhooks, differentiates between platform and merchant webhooks, and outlines various notification types related to transactions.
- Payment components (https://docs.embed.co/accept-payments/payment-components) The "Payment components" documentation page provides an overview of customizable pre-built payment widgets that can be embedded into webpages, allowing users to accept various payment methods seamlessly. It details three types of components—Standard, Headless, and Express—each suited for different integration needs, and outlines the steps for creating, handling, and rendering a checkout process.
- Payment links (https://docs.embed.co/accept-payments/payment-links) The "Payment Links" documentation page provides a low-code integration method for platforms to create customizable payment links, enabling merchants to accept payments online through a prebuilt payment page hosted by Embed. It outlines the steps for creating a checkout, handling responses, and customizing the payment page's language.
- Payment statuses (https://docs.embed.co/accept-payments/payment-statuses) The "Payment statuses" documentation page provides an overview of various payment statuses and their meanings, detailing how to retrieve the current status of a payment using a specific API endpoint. It outlines possible transaction types and statuses, along with recommended actions for each status, helping users understand and manage payment processes effectively.
- Payout configuration (https://docs.embed.co/accept-payments/payout-configuration) The "Payout Configuration" documentation page guides users on how to set up and manage payout settings for platforms and merchants, including configuring bank accounts, scheduling payouts, and handling different currencies and fees. It emphasizes the importance of submitting accurate payout details, as changes require direct contact with compliance, and explains the net settlement process for payouts after fees are applied.
- Payouts (https://docs.embed.co/accept-payments/payouts) The "Payouts" documentation page provides guidance on configuring payout accounts for merchants and platforms, detailing the types of payouts, processing periods, and the impact of weekends and holidays on payout schedules. It also explains how to set up payouts in different currencies, including applicable fees and foreign exchange rates.
- Payouts (https://docs.embed.co/accept-payments/payouts-overview) The "Payouts" documentation page provides guidance on configuring payout settings for platforms and merchants, understanding fund availability and processing periods, and accessing settlement reports for reconciliation. It enables readers to effectively manage the payout process for processed payments.
- Refund statuses (https://docs.embed.co/accept-payments/refund-statuses) This documentation page provides an overview of refund and cancellation statuses, detailing how to retrieve the current status of a refund using a specific API endpoint and explaining the meanings of various statuses and reasons for declines. It enables readers to understand refund processing stages and troubleshoot issues related to refunds and cancellations effectively.
- Payout reporting (https://docs.embed.co/accept-payments/settlement-of-funds) The "Payout Reporting" page directs readers to the new location for accessing payout reconciliation details, specifically at the provided link to "Payout reports."
- Transaction reporting (https://docs.embed.co/accept-payments/transaction-export-csv) This documentation page informs readers that the transaction reporting guide has been relocated to a new URL, providing updated instructions and field definitions for transaction reports. Users are advised to update their bookmarks accordingly.
- Authentication (https://docs.embed.co/api-reference/authentication) This documentation page provides a guide on how to authenticate API requests using Basic authentication in the Embed API, detailing the steps to obtain an API key and how to use it for authentication in HTTP requests.
- Environments (https://docs.embed.co/api-reference/environments) The "Environments" documentation page provides URLs for accessing Embed's API and Dashboard in both Sandbox (for testing and development) and Production (for live transactions) environments, highlighting the need for separate accounts for each.
- Error response format (https://docs.embed.co/api-reference/errors) This documentation page outlines the various error response formats for API requests, detailing specific error types such as malformed parameters, invalid requests, resource not found, permission issues, and server errors, along with their corresponding JSON response structures and status codes. It enables readers to understand and troubleshoot potential errors encountered when interacting with the API.
- Bank confirmation letters (https://docs.embed.co/compliance-operations/bank-confirmation-letters) This documentation page explains that bank confirmation letters cannot be issued for virtual IBANs used by Merchants on Embed, as these IBANs are linked to the master account of Stichting Custodian Embed rather than to individual Merchants. It clarifies the structural nature of virtual IBANs in the banking industry and outlines how they function within the Embed system.
- Contract Guide (https://docs.embed.co/compliance-operations/contract) The Contract Guide outlines the necessary agreements for Platforms to integrate Embed's Payment Services for their Merchants, detailing the roles and responsibilities of each party involved. It explains the structure of the Platform Agreement and Terms & Conditions, including payment processing, fees, and the onboarding process for Merchants, enabling Platforms to effectively manage payment services and relationships with their customers.
- Merchant Onboarding (https://docs.embed.co/compliance-operations/merchant-onboarding) The Merchant Onboarding documentation provides a comprehensive guide for platforms to onboard merchants for payment services, ensuring compliance with financial regulations such as AML, KYC, and KYB. It outlines the onboarding process, including the creation of merchant accounts, the phased verification approach, and the necessary documentation required for merchants to start accepting payments efficiently and securely.
- Merchant onboarding (https://docs.embed.co/compliance-operations/merchant-onboarding-overview) The Merchant Onboarding documentation page provides a comprehensive guide on the process of verifying and approving Merchants for payment services, detailing the requirements, verification steps, legal agreements, and the significance of merchant category codes. It enables readers to understand and navigate the onboarding process efficiently, ensuring compliance and branding consistency.
- Safeguarding (https://docs.embed.co/compliance-operations/safeguarding) The Safeguarding documentation explains how Embed B.V. protects Merchant funds by keeping them separate from its own assets, in compliance with legal requirements under PSD2. It details the role of Stichting Custodian Embed, a foundation that securely holds these funds in a dedicated bank account, ensuring their safety and availability even in the event of insolvency.
- Setting Up a Merchant Account (https://docs.embed.co/compliance-operations/setting-up-a-merchant-account) This documentation page provides a comprehensive guide for setting up a merchant account on the Embed platform, detailing the essential steps for onboarding merchants, ensuring compliance with verification requirements, accepting terms and conditions, configuring pricing plans, establishing payment profiles, and facilitating payouts. It enables platform users to effectively manage the entire merchant setup process for payment processing and payouts.
- Support Structure for Platforms (https://docs.embed.co/compliance-operations/support) The "Support Structure for Platforms" documentation outlines the comprehensive support framework provided by the payment service provider (PSP) to assist platforms and their merchants through integration, onboarding, and ongoing operational support. It details the processes for technical assistance, compliance checks, training, and a structured ticketing system for addressing issues, ensuring a seamless payment service experience.
- Verification Process (https://docs.embed.co/compliance-operations/verification-process) The Verification Process documentation outlines the mandatory checks and documents required for onboarding merchants at Embed, ensuring compliance with legal obligations such as Anti-Money Laundering regulations. It details the necessary documentation for company and identity verification, including requirements for Ultimate Beneficial Owners and Authorized Representatives, as well as bank account verification criteria.
- Accounts (https://docs.embed.co/core-concepts/accounts) The "Accounts" documentation page explains how to manage different account types within a software platform, including platform accounts, merchant accounts, and operating accounts, enabling users to onboard merchants, configure payment methods, and consolidate financial reporting. It also provides use case examples and guidance on designing integrations tailored to specific business models.
- Balance accounts (https://docs.embed.co/core-concepts/balance-accounts) The "Balance accounts" documentation page provides an overview of how to manage funds on Embed's platform through balance accounts, which can hold and manage funds for various parties, including merchants and service providers. It outlines use cases such as revenue sharing, bulk reimbursements, and SaaS fee charging, while also detailing the different account types and industry-specific solutions available.
- Balance account clearing (https://docs.embed.co/core-concepts/balance-accounts/clearing) The "Balance account clearing" documentation page explains how to automate the distribution of funds collected from payments to standard balance accounts, including details on payment processing, clearing configuration, and currency conversion. It also outlines use cases for optimizing currency management and operational flexibility within payment flows.
- External balance accounts (https://docs.embed.co/core-concepts/balance-accounts/external-balance-accounts) The "External balance accounts" documentation page explains how to manage funds for third parties related to your platform, detailing the separate onboarding process required for these accounts, the Payouts capability necessary for disbursing funds, and compliance considerations. It also provides links to onboarding requirements, workflows, and related concepts for better understanding and implementation.
- Onboarding requirements (https://docs.embed.co/core-concepts/balance-accounts/external-balance-accounts/requirements) This documentation page outlines the onboarding requirements for enabling the PAYOUTS_EXTERNAL capability on external balance accounts, detailing specific information and documentation needed for both individual and organizational legal entities. It provides a structured list of required fields and documents, ensuring compliance with verification processes.
- Onboarding workflow (https://docs.embed.co/core-concepts/balance-accounts/external-balance-accounts/workflow) This documentation page provides a comprehensive guide for building an external balance account onboarding experience using Embed's APIs, allowing users to create accounts, check requirements, update legal entity information, add associated parties, upload necessary documents, and request capability plans, all while maintaining control over the user interface and data flow. It emphasizes the importance of understanding capability plan lifecycles and onboarding requirements before starting the process.
- Balance account payments (https://docs.embed.co/core-concepts/balance-accounts/payments) The "Balance account payments" documentation page explains how to facilitate fast and low-cost internal transactions between parties on the platform, covering use cases like third-party payments, subscription fees, and service charges. It also details currency conversion, pending payment management, and the setup of notifications for tracking payment statuses.
- Balance account payouts (https://docs.embed.co/core-concepts/balance-accounts/payouts) The "Balance account payouts" documentation page enables readers to configure automatic fund withdrawals from balance accounts to external bank accounts, detailing how to set up payout schedules, destinations, and preferences for various use cases like merchant payouts and customer reimbursements. It also outlines workflows for creating, adding, and updating payout configurations.
- Standard balance accounts (https://docs.embed.co/core-concepts/balance-accounts/standard-balance-accounts) The "Standard balance accounts" documentation page explains that these accounts are automatically created for merchants after onboarding, allowing them to hold funds from payment processing, receive payouts, make transfers, and fund outgoing payments. It also provides guidance on related topics such as external balance accounts and money movements.
- Balance account top-ups (https://docs.embed.co/core-concepts/balance-accounts/top-ups) The "Balance account top-ups" documentation page explains how to add funds to balance accounts via bank transfers using unique Virtual Account Numbers (VANs), facilitating automatic reconciliation and reducing manual processing. It outlines the top-up process for both standard and external balance accounts, including fund availability timelines and notification setups for tracking incoming payments.
- Balance account transfers (https://docs.embed.co/core-concepts/balance-accounts/transfers) The "Balance account transfers" documentation page enables readers to understand how to move funds between balance accounts on the platform for various purposes, such as revenue sharing and commission payments, while outlining restrictions on currency and external accounts, as well as the asynchronous nature of transfer processing.
- Branding (https://docs.embed.co/core-concepts/branding) This documentation page explains how to customize the branding of the Platform, allowing users to create and manage custom themes for their Dashboard and Checkouts using Theming APIs. It highlights the benefits of consistent branding, such as increased brand recognition, improved customer trust, and a competitive advantage, while providing step-by-step instructions for creating and applying a new theme.
- Balance account capabilities (https://docs.embed.co/core-concepts/merchant-onboarding/balance-account-capabilities) The "Balance account capabilities" documentation page enables merchants to request payouts to external balance accounts, facilitating fund disbursement to third parties like service providers or referral partners, while outlining the compliance requirements for both individuals and organizations. It details the necessary documentation and information needed for approval by Embed's compliance team before enabling these capabilities.
- Capabilities (https://docs.embed.co/core-concepts/merchant-onboarding/capabilities-overview) The "Capabilities" documentation page outlines the services available to merchants and external balance accounts, detailing how to enable these capabilities through various plans, each with specific requirements and constraints. It also describes the lifecycle of capability plans, from initial request to approval, including necessary compliance verification steps.
- Merchant capability requirements (https://docs.embed.co/core-concepts/merchant-onboarding/merchant-capabilities) The "Merchant capability requirements" documentation outlines the necessary criteria and plans for merchant accounts to accept payments and receive payouts, detailing specific requirements for legal entities and individual representatives, as well as constraints associated with the PAYMENTS_LIMITED plan. It enables readers to understand the compliance and documentation needed to initiate payment processing effectively.
- Merchant onboarding (https://docs.embed.co/core-concepts/merchant-onboarding/merchant-onboarding-overview) The "Merchant Onboarding" documentation page provides an overview of the legal entities and capabilities associated with merchant accounts, detailing the types of legal entities (organizations and individuals), their associations, required compliance documents, and the services (capabilities) merchants can access based on their onboarding status. It enables readers to understand the necessary steps and documentation for onboarding merchants effectively.
- Onboarding workflows (https://docs.embed.co/core-concepts/merchant-onboarding/onboarding-workflow) The "Onboarding Workflows" documentation page outlines three onboarding approaches for merchants—API, Hosted UI, and a Mixed method—allowing readers to select the best fit for their platform's needs and technical capabilities. It provides guidance on each option, including their advantages and ideal use cases, enabling platforms to effectively implement merchant onboarding.
- API onboarding workflow (https://docs.embed.co/core-concepts/merchant-onboarding/onboarding-workflow/api) The API onboarding workflow documentation provides a comprehensive guide for building a custom merchant onboarding experience using Embed's APIs, enabling users to create merchant accounts, check outstanding requirements, add associated parties, upload documents, sign agreements, request capability plans, and manage compliance reviews effectively. It emphasizes the importance of understanding the capability plan lifecycle and offers specific API endpoints for each step of the onboarding process.
- Hosted UI onboarding workflow (https://docs.embed.co/core-concepts/merchant-onboarding/onboarding-workflow/hosted) The "Hosted UI onboarding workflow" documentation provides a comprehensive guide for onboarding merchants through Embed's white-label portal, detailing the steps to create merchant accounts, collect business information, and manage document uploads, all while ensuring compliance with terms and conditions. It outlines both API and dashboard methods for each step, facilitating a streamlined onboarding process for merchants.
- Payment lifecycle (https://docs.embed.co/core-concepts/payment-lifecycle) The "Payment Lifecycle" documentation page provides a detailed overview of the steps involved in both successful and unsuccessful payments, including authorization processes and various statuses that can occur during transactions. It also outlines additional processes such as refunds, disputes, and payouts, enabling readers to understand the complete payment flow and manage different payment scenarios effectively.
- Payment Profiles (https://docs.embed.co/core-concepts/payment-profiles) The "Payment Profiles" documentation page provides guidance on creating and managing payment profiles for merchants, detailing required information, payment methods, configurations for card payments, and how to customize statement descriptors. It outlines both the dashboard and API methods for creating payment profiles, enabling merchants to effectively manage their payment processing options.
- Pricing plan (https://docs.embed.co/core-concepts/pricing-plans) The Pricing Plan documentation page enables readers to understand how to set and manage fees for processing payments, including options for different pricing models (Blended and IC++), and outlines how these fees apply to transactions, refunds, and currency conversions for both platforms and merchants. It also provides guidance on associating pricing plans with merchant accounts to facilitate payment processing.
- Roles & permissions (https://docs.embed.co/core-concepts/roles-and-permissions) The "Roles & Permissions" documentation page explains how to use Role-based Access Control (RBAC) within the Embed platform to manage user and API key access to resources based on their assigned roles and account types. It provides guidance on viewing and managing users and API keys through the dashboard, detailing the specific roles and permissions available for both Platform and Merchant accounts.
- Automotive platform solutions (https://docs.embed.co/guides/automotive-industry-guide) The "Automotive platform solutions" documentation page outlines Embed's payment solutions tailored for automotive platforms, enabling car dealerships, leasing companies, and service providers to manage complex multi-party payment flows, secure escrow transactions, and deliver a unified payment experience across various channels. It also provides insights into specific use cases and benefits, such as automatic payment distribution and secure fund holding.
- API integration for card payments (https://docs.embed.co/guides/card-payments-api) This documentation page provides a comprehensive guide for integrating card payment APIs, including the necessary steps for 3DS authentication, data collection requirements, and sample code for both frontend and backend implementations, while emphasizing the importance of PCI compliance. It enables readers to understand how to securely collect card and customer data, initiate payment processes, and handle authentication flows effectively.
- Revenue sharing payments to site hosts (https://docs.embed.co/guides/cpo-payments-to-site-hosts) This documentation page provides guidance for Charging Point Operators (CPOs) on implementing revenue sharing and fixed rental payment models for site hosts using Embed's payment infrastructure, enabling automated payouts, flexible payment frequencies, and comprehensive payment tracking. It outlines the roles and responsibilities of each party involved, as well as the payment process from CPOs to site hosts.
- Electric vehicle (EV) platform solutions (https://docs.embed.co/guides/ev-industry-guide) The Electric Vehicle (EV) platform solutions documentation outlines payment solutions for EV charging platforms, enabling users to manage complex multi-party payment flows involving charge point operators, mobility service providers, and site hosts. It details key benefits such as unified payment services, revenue sharing, and reimbursement processes, supported by diagrams illustrating various use cases.
- Field services platform solutions (https://docs.embed.co/guides/field-services-industry-guide) The documentation page outlines payment solutions for field services platforms, enabling users to manage complex multi-party payment flows, including project escrow and staged payments for contractors and service providers. It highlights key benefits such as automated commission management and secure fund handling, while also providing examples and resources for further exploration.
- Home charging reimbursements (https://docs.embed.co/guides/home-charging-reimbursements) The "Home Charging Reimbursements" documentation page enables fleet managers to automate the reimbursement process for EV drivers charging at home through a single integration with Embed, which manages compliance, onboarding, and fund disbursements. It outlines key features, roles, responsibilities, and the reimbursement workflow, including account funding, transfers, and driver payouts.
- Management platform solutions (https://docs.embed.co/guides/management-software-industry-guide) The "Management platform solutions" page outlines payment solutions for management software platforms catering to sports clubs, educational institutions, recreation centers, and professional services, enabling automated financial management and enhanced member experiences. It details functionalities like membership fee collection, multi-party payment distribution, and provides flow diagrams for specific use cases, while inviting users to contact for tailored solutions.
- Migration from Merchant of Record to Platform model (https://docs.embed.co/guides/migration-to-platform) This documentation page provides a step-by-step guide for transitioning from a Merchant of Record model to a Platform model using Embed's services, enabling users to manage multiple Merchants under a single account while alleviating financial and legal liabilities. It outlines the benefits of the Platform model, the necessary account setups, onboarding processes, and technical requirements for successful migration.
- Proptech platform solutions (https://docs.embed.co/guides/proptech-industry-guide) The Proptech platform solutions page outlines payment solutions for property technology platforms, enabling users to manage complex multi-party payment flows involving property managers, landlords, tenants, and platform providers. It details features such as automated rent collection, revenue sharing, and rental deposit management, along with visual flow diagrams to illustrate these processes.
- EV charging payments integration guide (https://docs.embed.co/guides/qr-payments-ev-charging) The EV charging payments integration guide outlines a step-by-step process for implementing a QR code payment flow for EV chargers, enabling drivers to easily complete transactions through a secure payment link. It covers prerequisites, payment method selection, QR code generation, and transaction confirmation, ensuring a seamless charging experience for users.
- Card Recurring and Unscheduled Payments (https://docs.embed.co/guides/recurring-payments) This documentation page provides a step-by-step guide for implementing card-based recurring and unscheduled payments in a system, detailing how to create payment profiles, initiate checkouts, collect payment details, and trigger payments. It enables readers to understand the process of managing customer payments on a regular basis or as needed, ensuring they can effectively integrate these payment methods into their applications.
- Ticketing platform solutions (https://docs.embed.co/guides/ticketing-industry-guide) The "Ticketing platform solutions" documentation page outlines payment solutions for ticketing platforms, enabling users to manage complex escrow and multi-party payment flows for events, venues, and performers. It details suitable users, key benefits such as event escrow management and multi-party revenue sharing, and provides a flow diagram for event ticketing sales.
- Twint E-commerce (https://docs.embed.co/guides/twint-ecommerce) The Twint E-commerce documentation provides a comprehensive guide for integrating Twint as a payment method in e-commerce platforms, detailing prerequisites, the payment initiation process, QR code authorization, and payment capture. It includes code examples and links to relevant API references to facilitate implementation.
- Twint QR Payments on Terminal (https://docs.embed.co/guides/twint-qr-on-terminal-payments) This documentation page provides a comprehensive guide for integrating Twint QR payments on terminals for EV charging, detailing the necessary prerequisites, steps for generating and displaying QR codes, and handling transaction notifications. It enables readers to effectively set up and manage Twint payments through their terminals using the Embed Payment API.
- Unscheduled charges (https://docs.embed.co/guides/unscheduled-charges) This documentation page provides guidance on setting up and initiating unscheduled charges for usage-based billing, account top-ups, and other irregular payment scenarios using various payment methods, including Cards, SEPA Direct Debit, and BACS Direct Debit. It outlines the prerequisites, setup processes, and examples to effectively manage variable payment amounts at irregular intervals.
- Wellness platform solutions (https://docs.embed.co/guides/wellness-industry-guide) The "Wellness platform solutions" documentation page outlines payment solutions for wellness platforms, enabling users to manage complex multi-party payment flows for fitness studios, instructors, and wellness service providers. It highlights suitable use cases, key benefits like unified commerce and automated payments, and provides a flow diagram to illustrate the payment process.
- Setting up Payter terminals (https://docs.embed.co/in-person-payments/setting-up-pos-payments) This documentation page provides a comprehensive guide for setting up Payter terminals to use Embed as a payment processor, detailing the steps for both new setups and migrations, including account creation, terminal identification, and data enrichment. It ensures that users can complete the setup process without technical integration and within a few business days.
- Integration checklist (https://docs.embed.co/integration-checklist) The Integration Checklist provides step-by-step guidelines and best practices to ensure a smooth integration process, covering essential tasks such as setting up a Sandbox account, obtaining an API key, configuring Webhooks, and testing the integration. It also offers support through a dedicated Slack channel for any questions.
- Embedded Payments designed for Software Platforms (https://docs.embed.co/integration/get-started) This documentation page provides a comprehensive guide for software platforms to integrate embedded payment solutions, enabling users to onboard merchants, accept various payment methods, manage funds, and configure payouts efficiently. It outlines a step-by-step process for setting up an Embed account, building and verifying integrations, onboarding merchants, and managing operations, along with access to APIs and resources for a seamless integration experience.
- Verifying the merchant integration (https://docs.embed.co/integration/verifying-the-integration) This documentation page provides a comprehensive guide for Platform technical and operations teams to verify Merchant integrations with Embed's payment infrastructure, ensuring robust error handling, proper notification processing, and responsive design before moving to production. It includes a detailed checklist covering configuration reviews, transaction testing, response handling, user experience validation, and security compliance to minimize payment failures.
- Vipps payments using Embed (https://docs.embed.co/integration/vipps-payments) This documentation page provides a comprehensive step-by-step guide for integrating Vipps payments using Embed, enabling merchants in Norway, Denmark, and Finland to accept and manage payments through the popular Nordic wallet. It outlines the onboarding process, money flow, and necessary configurations for successful integration and payment processing.
- 3D Secure (https://docs.embed.co/payment-features/3d-secure) The 3D Secure documentation page explains the protocol that enhances security for online credit and debit card transactions by requiring additional authentication, reducing fraud risk, and potentially shifting liability for chargebacks from merchants to card issuers. It also outlines compliance requirements across different regions, various transaction scenarios, and reporting capabilities related to 3D Secure transactions.
- Disputes (https://docs.embed.co/payment-features/disputes) The "Disputes" documentation page provides an overview of the dispute process, enabling merchants to understand how to respond to customer chargebacks, including the lifecycle of a dispute, the necessary actions to take, and the specific flows for different card networks like Visa and Mastercard. It also outlines how to view disputes and set up webhooks for notifications.
- Follow-up payment actions (https://docs.embed.co/payment-features/follow-up-payment-actions) The "Follow-up payment actions" documentation page provides guidance on managing existing payments, including capturing authorized amounts, canceling authorizations, processing refunds, and handling technical reversals. It details the options available for each action via both API and Dashboard, enabling users to effectively manage customer transactions.
- Idempotency keys (https://docs.embed.co/payment-features/idempotency-keys) The documentation page on idempotency keys explains how to use unique identifiers to prevent double-payments in the Payments API, ensuring that each payment is processed only once. It details the implementation of idempotency keys, their validity period, and how to handle responses effectively.
- Incremental authorization (https://docs.embed.co/payment-features/incremental-authorization) The "Incremental Authorization" documentation page explains how merchants can increase the amount of a previously authorized transaction multiple times before capture, ensuring customers are informed that the final charge may exceed the initial authorization. It outlines the setup requirements for payment profiles, compliance responsibilities, and the steps to increment and capture transactions, emphasizing the importance of transparent communication with customers.
- Payment features (https://docs.embed.co/payment-features/overview) The "Payment Features" documentation page provides an overview of advanced payment functionalities that can enhance payment processing capabilities, enabling users to integrate and utilize these features effectively in their applications.
- Recurring payments (https://docs.embed.co/payment-features/recurring-payments) The documentation page explains how to process recurring and unscheduled payments using stored customer payment information, detailing the steps for securely saving payment details, obtaining customer consent, and charging customers based on predefined agreements. It also highlights the importance of compliance with payment regulations and provides guidance on using the Payments API for executing these transactions.
- Settlement of Funds (https://docs.embed.co/payment-features/settlement-types) The "Settlement of Funds" documentation explains how Embed processes financial settlements, detailing the deduction of fees from the total amount before transferring the net settlement to either the merchant's or the platform's bank account.
- Supported currencies (https://docs.embed.co/payment-features/supported-currencies) This documentation page provides a comprehensive list of 21 supported currencies for payment processing and 12 supported currencies for payouts, while also noting that some payment methods may have limited currency support. It informs readers about potential currency exchange fees when the payout currency differs from the processing currency.
- Transaction Types (https://docs.embed.co/payment-features/transaction-types) The "Transaction Types" documentation page provides an overview of various payment transaction types and their configurations, enabling readers to select the appropriate setup for their business needs based on specific scenarios like one-off purchases, recurring payments, and unscheduled charges. It also outlines key considerations for configuring payment profiles to support different transaction types effectively.
- Apple Pay™ (https://docs.embed.co/payment-methods/apple-pay) This documentation page provides an overview of Apple Pay, detailing its features, integration requirements, and domain registration process for secure payments via Apple devices. It enables readers to understand how to implement Apple Pay, including necessary prerequisites, verification steps, and testing procedures.
- BACS Direct Debit (https://docs.embed.co/payment-methods/bacs-direct-debit) The BACS Direct Debit documentation provides an overview of the BACS Direct Debit payment method in the UK, detailing its integration process, features, and payment timeline, enabling readers to set up and manage recurring payments effectively. It includes instructions for creating payment contracts, collecting debtor details, and handling webhooks for transaction authorization.
- Card Payments (https://docs.embed.co/payment-methods/card-payments) The "Card Payments" documentation page provides a comprehensive overview of an omni-channel card payment solution, detailing its features, transaction types, security measures, and integration methods. It enables readers to understand how to implement and manage card payments for both online and in-person transactions, ensuring a secure and efficient payment process.
- Google Pay™ (https://docs.embed.co/payment-methods/google-pay) The Google Pay™ documentation provides an overview of how to implement fast and secure mobile payments for customers using Android devices or desktop browsers, detailing key features, integration methods, testing procedures, and requirements for going live. It enables readers to understand the benefits of Google Pay, including one-tap payments, strong authentication, and support for various payment types and currencies.
- iDEAL (https://docs.embed.co/payment-methods/ideal) The iDEAL documentation page provides an overview of the leading online payment method in the Netherlands, detailing its features, integration options, and requirements for enabling direct bank transfers. It guides users through the setup process for accepting iDEAL payments, including testing in a sandbox environment and going live with production configurations.
- Open Banking (https://docs.embed.co/payment-methods/open-banking) The Open Banking documentation page provides an overview of a modern payment solution that enhances bank transfers through instant account verification, secure authentication, and a user-friendly experience, all powered by Plaid. It outlines key benefits for both customers and merchants, integration methods, and testing procedures in a sandbox environment, enabling users to implement and optimize Open Banking in their payment systems.
- SEPA Direct Debit (https://docs.embed.co/payment-methods/sepa-direct-debit) The SEPA Direct Debit documentation page provides an overview of the SEPA Direct Debit payment method, detailing its key features, integration setup, and payment timelines, enabling readers to understand how to implement and manage recurring payments across Europe effectively. It also outlines the process for creating payment contracts and collecting debtor details through various methods.
- Twint™ (https://docs.embed.co/payment-methods/twint) The Twint™ documentation page provides an overview of Switzerland's mobile payment app, detailing its features, integration methods, and requirements for going live, enabling users to implement and utilize Twint for secure payments in various settings. It also outlines necessary guidelines for QR code design to ensure compliance and approval for merchants.
- Vipps (https://docs.embed.co/payment-methods/vipps) The Vipps documentation provides an overview of the popular Nordic mobile payment solution, detailing its features, integration methods, and testing requirements, enabling users to set up and accept payments through Vipps in their applications. It also outlines the steps for going live, including account registration and onboarding processes.
- How to set up pricing plans (https://docs.embed.co/pricing-plans/how-to-set-up-a-pricing-plan) This documentation page provides a comprehensive guide on how to create and manage pricing plans for processing payments, including setting default and custom pricing, selecting applicable accounts, and editing existing plans. It enables users to understand the steps necessary to establish effective pricing strategies tailored to their business needs.
- What can you charge fees for? (https://docs.embed.co/pricing-plans/what-can-you-charge-fees-for) This documentation page outlines the various fees that can be charged for payments, refunds, payouts, and currency conversions within a platform using IC++ or blended pricing models. It details how to set up custom fees based on transaction types and card categories to ensure that processing costs do not impact the platform's profitability.
- Get started with reporting (https://docs.embed.co/reporting) This documentation page provides an overview of reporting capabilities in Embed, detailing how to access and utilize Activity and Payout reports for financial reconciliation and visibility into fund movements. It explains the types of reports available, their purposes, and the processes for generating and retrieving them through the Dashboard and API.
- Activity reports (https://docs.embed.co/reporting/activity-reports) The "Activity Reports" documentation page provides users with the ability to generate comprehensive reports detailing all fund movements across their accounts for specified periods, aiding in financial reconciliation and understanding account changes. It offers two views—Merchant and Platform—each tailored to different financial perspectives, and outlines the various columns included in the reports, detailing event types, timestamps, and transaction identifiers.
- Accounting workflows with Activity reports (https://docs.embed.co/reporting/activity-reports/accounting-workflows) This documentation page provides guidance on integrating Activity reports into accounting workflows, enabling users to perform daily double-entry bookkeeping, track Accounts Receivable, filter financial impacts, and conduct monthly reconciliations effectively. It outlines the steps for generating reports, managing balances, and ensuring accurate financial reporting.
- Payout reports (https://docs.embed.co/reporting/payout-reports) The Payout Reports documentation enables users to understand and reconcile the details of debits and credits that constitute a payout, providing insights into bank deposits, transaction breakdowns for merchants, and validation of platform revenue and fees. It outlines the availability and structure of merchant and platform payout reports, including the specific data columns included in each report variant.
- Transactions report (https://docs.embed.co/reporting/transactions-report) The Transactions report page enables users to export a comprehensive snapshot of all transactions processed by Embed for purposes such as operational monitoring, customer support, and reconciliation. Users can access the report via the dashboard or API, applying filters to customize the dataset, and it includes detailed metadata fields for each transaction.