Payout components

To help your users reconcile their payouts, you can integrate payout components into your platform's user interface (UI). These components offer a dashboard view of completed payouts for each user's balance account. Your users can use this information to match the payouts they receive in their bank account with the batches of payments and other related transactions.

The payout components are designed for users who receive automatic payouts. Unlike on-demand payouts, automatic payouts are initiated by Adyen based on your configured rules. This enables the payout components to show all relevant debit and credit transactions for the balance account.

This page provides information on:

• The available payout components, which include the Payouts Overview component and the Payout Details component.
• The steps needed to integrate these components into your platform.

Payouts Overview component

The Payouts Overview component shows a list of automatic payouts completed for a specific balance account within a specified time period. Each payout record includes details such as the date and time, funds captured, total adjustments, and net payout.

The funds captured represent the initial amount in the balance account on the day when a payout is initiated. This amount may be adjusted due to factors like fees, commissions, refunds, business financing, or internal funds transfers. The component presents these adjustments in an aggregated view. If you need to provide your users with a detailed breakdown of the payout adjustments, refer to the Payout Details component.

After being adjusted, the funds captured amount results in the net payout amount, which is the final amount credited to the user's bank account.

All amounts are shown in the currency of the chosen balance account.

The Payouts Overview component enables users to:

• View a list of automatic payouts completed for a balance account, including funds captured, adjustments, and net payout amounts per payout.
• Filter payouts by time period and balance account (if applicable). See the available filters for more details.

By default, the Payouts Overview component includes the Payout Details component, which provides more details about a specific payout.

Available filters

The following sections shows the available filters and their values for the Payouts Overview component.

Payout Details component

The Payout Details component shows specific information about a payout, including the date and time, breakdown of captured funds and adjustments, and the net payout amount. If there are any remaining funds in the balance account after the payout is completed, they will also be shown in the component.

By default, the Payout Details component is embedded in the Payouts Overview component and is shown as a modal window on the overview page. You can also choose to show the Payout Details component on a separate page during the initialization of the components.

Requirements

Before integrating the components, make sure that you:

• Followed the Get started guide to create your test account.
• Created API credentials for the Configuration API or the Transfers API.
• Asked your Adyen contact to assign the Payouts Overview Component: View role to your API credential.
• Verified that the components are available in the languages and browser versions that apply to your situation.

How it works

Follow these steps to integrate the payout components:

1. Create an authentication session from your server
2. Install the component library on your front end
3. Initialize the components
4. Customize the components

Step 1: Create an authentication session from your server

To ensure secure communication between components and Adyen server, you must configure your server for authentication and create a session token. To create the token:

1. From your server, make a POST /sessions request specifying the following parameters:

   To make this API request, your API key must have the Payouts Overview Component: View role in your Customer Area. Read more in Requirements.

   Parameter	Required	Description
   allowOrigin		The URL where the component will appear. Must follow the format of https://www.yourcompany.com or https://*.yourcompany.com, where yourcompany.com is the actual web address of your platform. On live, only the HTTPS protocol is supported. An asterisk (*) cannot be used as a literal value for the parameter.
   product		The component type. Set this to platform.
   policy		An object that contains: resources: An object that contains: accountHolderId: The unique identifier of the account holder that is linked to the balance account shown in the component. type: The type of resource. Set this to accountHolder. roles: The role required to use the component. Set this to Payouts Overview Component: View.

   Here is an example request for creating a session token.

2. Note the API response. Later, when initializing the components, you need to create and call a function that passes the entire session object from the response to your front end.

Step 2: Install the component library on your front end

Use the Adyen Platform Experience library in your front-end application as follows:

1. Install the node package.

   npm install @adyen/adyen-platform-experience-web

2. Import the node package, the components, and the style sheet.

   import { AdyenPlatformExperience, PayoutsOverview, PayoutDetails } from '@adyen/adyen-platform-experience-web';
   import "@adyen/adyen-platform-experience-web/adyen-platform-experience-web.css";

Step 3: Initialize the components

To initialize the components:

1. Gather the following information to be passed when initializing the library and its components.

   1. Gather these parameters to initialize the library.

      Parameter	Required	Description
      onSessionCreate		The function callback that retrieves an authentication session token and refreshes/extends the current session.
      locale		The language of the component. See the list of the supported languages. For example, use en-US for English.
      environment		The environment for the component integration. The default value is test. Set the parameter to live when you are ready to go live.

   2. Gather these parameters to initialize each component.

      Select the tab for the component you want to use:

2. Create a DOM element on your UI page where you want the component to be rendered and assign it a unique and descriptive ID. This unique ID is important to avoid any misconfigurations when integrating multiple components into your UI.

   By default, the Payout Details component is shown as a modal window within the Payouts Overview component. In this scenario, you only need to create a DOM element for the Payouts Overview component. If you want to use the Payout Details component on its own, you need to create a separate DOM element for it.

   If you are using JavaScript frameworks such as Vue or React, make sure that you use references instead of selectors and that you do not re-render the DOM element.

   Select the tab for the component you want to use:

3. Add a function that calls your API to generate a new authentication session token.

   The following code, including the role, is the same for both payout components.

4. Initialize the component and mount it to the container you created. At this step, you can localize the components by setting a preferred language.

   To implement the Payout Details component as a modal window within the Payouts Overview component, use the following code examples. In this implementation, when the user selects a specific payout from the overview page, the payout date and the corresponding balance account ID are automatically passed to the Payout Details component, and the modal window opens.

   Select the tab for the component you want to use:

   To use the Payout Details component outside of the Payouts Overview component, define the onRecordSelection event as shown below.

Step 4: (Optional) Customize the components

The payout components have a default appearance with pre-defined styles, such as colors, fonts, and borders. You can customize the appearance of your components by overriding the default values of CSS variables and the class styles:

1. Inspect the components using your browser's developer tools.
2. Modify the styles in your style sheet file.

The following tabs show examples of how to style the components. The first example shows how to override predefined CSS variables to use different colors and values. The second example demonstrates how to update the CSS class setting to change the layout of the modal window from a pop-up window to a side panel view.

See also