---
title: "Transaction components"
description: "Use Platform Experience components to build interactive dashboards for your users."
url: "https://docs.adyen.com/platforms/components-overview/after-payment/transactions-component"
source_url: "https://docs.adyen.com/platforms/components-overview/after-payment/transactions-component.md"
canonical: "https://docs.adyen.com/platforms/components-overview/after-payment/transactions-component"
last_modified: "2026-09-15T14:06:03+02:00"
language: "en"
---
# Transaction components
Use Platform Experience components to build interactive dashboards for your users.
##### Learn more
 [View our repository on GitHub](https://github.com/Adyen/adyen-platform-experience-web)
 [Try it out with a live demo](https://demotool.adyen.com/se/pie/platform-tx)
 [Explore the latest updates](/release-notes/platforms-and-financial-products)
Transaction components enable you to offer comprehensive transaction management in your portal's user interface (UI) with minimal engineering effort. These components integrate all the features required to search, analyze, and manage transaction records without making multiple API requests. This means you do not need to implement complex API calls to filter balance accounts, calculate net amounts, or trigger refunds. The components handle all of this automatically.
Additionally, the components provide greater flexibility for data customization. You can enrich the transaction view with your own custom fields, icons, links, and buttons, allowing the UI to align with your specific business needs.\
This page provides guidance on:
* The available transaction components, which include the **Transaction Overview** component and the **Transaction Details** component.
* A standard user flow that these components cover.
* Functionalities such as data exporting, insights, and processing refunds.
The guidance and features available may differ based on the library version in use. We recommend using the latest library version to take advantage of the newest features and improvements.
Ensure you select a version in the next section before starting your integration.
## Transaction components
Use Platform Experience components to build interactive dashboards for your users.
## Requirements
Before you begin, take into account the following requirements,limitations, and preparations.
| Requirement | Description |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Integration type** | You must have the Adyen for Platforms integration. |
| **API credentials** | You must have a [Balance Platform API key](/platforms/manage-access/api-credentials-web-service?tab=create-ws_1) (for example, **ws\[\_123456]@BalancePlatform.****\[YourBalancePlatform]**) to access the [Session authentication API](https://docs.adyen.com/api-explorer/sessionauthentication/latest/overview). Ensure that you have asked your Adyen contact to assign the following role to your API credential:- **Transactions Overview Component: View**
- **Transactions Overview Component: Manage Refunds** (required to process refunds through the components) |
| **Limitations** | **Document export limits:**- Export functionality is currently limited to the CSV file format only.
- The maximum number of rows per transaction export is 100. |
| **Setup steps** | Before you begin:- Verify that the component is available in the [languages](#supported-languages) that apply to your situation.
- Check our [Component libraries](/platforms/components-overview) page for additional information on the supported countries/regions and browser versions. |
### Component Description
## Transactions Overview component
The **Transactions Overview** component shows a list of transactions processed for a specific balance account within a specified time period. Each transaction record includes details such as the date and time, payment method, transaction type, net amount, and gross amount. Additionally, the component allows for custom data integration, such as your own fields, icons, links, and buttons. For example, you can rename a column to match your branding or rearrange columns to change the display order.
This component organizes transactions into two tabs:
* **Transactions**: shows account balances, which display the account balance (available funds) and the reserved balance (funds currently held in reserve). Key features include:
* **Transaction list**: a detailed list of transactions, which can be [filtered](#available-filters).
* **Transaction details**: users can select a record to open the [**Transaction Details** ](#transaction-details-component)component, which provides granular information about that specific transaction.
* **CSV export**: an export button allows users to generate a CSV file containing the first 100 transactions that match the applied filters. Users retain control over the specific transaction fields included in the exported file.
* **Insights**: shows an analytical summary of transaction data for a specific balance account and time period. This data helps with bookkeeping, reconciliation, and financial analysis. This includes:
* **Period Result**: the net total for the specified period and currency, representing the difference between the total incoming and total outgoing funds.
* **Total Incoming**: the total amount of funds credited to the balance for all transactions processed during the specified period, grouped by transaction types, such as payments and transfers.
* **Total Outgoing**: the total amount of funds debited from the balance for all transactions processed during the specified period, grouped by transaction types, such as chargebacks and refunds.
The following illustrate each tab of the Transactions Overview component.
### Tab: Transactions
[](/user/pages/filters/pe-components-dashboards/transactions/1-10-0/component-description/transactions-overview-desktop.png)
### Tab: Insights
[](/user/pages/filters/pe-components-dashboards/transactions/1-10-0/component-description/transactions-insights-desktop.png)
The **Transactions Overview** component enables users to complete the following tasks:
* View a list of transactions for a balance account.
* View and export filtered transaction data as a CSV file for reconciliation and external analysis. Users can [filter](#available-filters) for transaction type, currency (for multi-currency accounts), PSP reference, and the time period specific to the balance account.
* View the available balance of the balance account, which shows the account balance and the reserved balance.
* View the total incoming and outgoing funds for a balance account. The total values update automatically when the user modifies the [filters](#available-filters). For example, users can filter to see the total booked incoming and outgoing funds that were processed during the past month.
By default, the **Transactions Overview** component includes the [**Transaction Details** ](#transaction-details-component)component, which provides more details about a specific transaction.
### Available filters
The following sections show the available filters and their values for the **Transactions Overview** component.
**
#### Balance account
Users with multiple balance accounts can switch between them using the **Balance Account** filter. This is available in both the **Transactions** and **Insights** tabs.
**
#### Time period
The **Time period** filter specifies the date and time range for displaying transaction results. The specified time is determined by the time zone of the selected balance account. This is available in both the **Transactions** and **Insights** tabs.
| Filter value | Description |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Last 7 days** | Includes transactions from the previous six days and from today until the current time. For example, if today is a Tuesday and the time is 8:00 PM, transactions from the previous Wednesday midnight until this Tuesday 8:00 PM are included. |
| **This week** | Includes transactions for the current week, starting from Monday midnight until the present moment. |
| **Last week** | Includes transactions from Monday midnight to Sunday 11:59:59 PM of the previous week. |
| **Last 30 days** | Includes transactions from the previous 29 days and from today until the current time. |
| **Last 180 days** | The default setting. Includes transactions from the previous 179 days from today until the current time. |
| **This month** | Includes transactions for the current month, starting from the first day of the month until today's date. |
| **Last month** | Includes transactions from the previous month, starting from the first day of the month until the end of the month at 11:59:59 PM. |
| **Year to date** | Includes transactions from the first day of the current year up until today's date. |
| **Custom** | Allows setting a custom time period. |
**
#### Type
The **Type** filter specifies which transaction types to show in the overview. The table below lists the available transaction types in the component along with their corresponding values returned in the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview). This is only available in the **Transactions** tab.
| Filter value | Value in the Transfers API | |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | - |
| **ATM** | `atmWithdrawal`, `atmWithdrawalReversal`. | |
| **Correction** | `manualCorrection`, `depositCorrection`, `leftover`, `balanceAdjustment`, `balanceRollover`, `installmentReversal`, `captureReversal`, `refundReversal`. | |
| **Payment** | `payment`, `capture`, `installment`. | |
| **Refund** | `refund` | |
| **Chargeback** | `chargeback`, `secondChargeback`, `chargebackReversal`. | |
| **Transfer** | `bankTransfer`, `internalTransfer`, `bankDirectDebit`. | |
| **Other** | Includes all other transaction types. | |
**
#### Currency
For multi-currency accounts, users can select their preferred currency for transactions overview. This is available in both the **Transactions** and **Insights** tabs.
**
#### PSP reference
The **PSP reference** filter enables users to find a transaction by specifying the exact PSP reference (equivalent to the internal Payment PSP reference), provided the transaction also matches the criteria of any other filters applied. This is only available in the **Transactions** tab.
## Transaction Details component
The **Transaction Details** component provides detailed information about a transaction, including its unique reference ID, the original amount, and any associated fees. For payment transactions, this component indicates whether a specific payment has been refunded. Additionally, it enables users to [refund payments](#refunds) to their shoppers. The component also allows for custom data integration, such as your own fields, icons, links, and buttons.
This component organizes the details of the transaction into three tabs:
* **Summary**: when available, shows the breakdown of the transaction, including net and gross amounts, applicable fees, and deductions. This view explicitly details the original amount processed and the net amount received by the user.
* **Details**: shows information about the transaction useful for tracking purposes, such as transaction references, including the unique reference ID. For payment transactions, this tab includes associated refund information. All custom integration data configured for the component is also displayed here.
* **Timeline**: when available, shows the complete payment processing history and status changes for the transaction.
By default, the **Transaction Details** component is embedded in the **Transactions Overview** component and is shown as a modal window on the overview page. You can also choose to show the **Transaction Details** component on a separate page during the [initialization of the components](#initialize-components).
The following tabs illustrate how the component appears on various screen sizes.
### Tab: Mobile
[](/user/pages/filters/pe-components-dashboards/transactions/1-10-0/component-description/transactions-details-mobile.png)
### Tab: Desktop
[](/user/pages/filters/pe-components-dashboards/transactions/1-10-0/component-description/transactions-details-desktop.png)
### Refund User Flow
## Processing refunds through components
The refund feature requires the **Transactions Overview Component: Manage Refunds** role to be assigned to your API credential and included in the session request.
Users can refund payments to their shoppers through the transaction components. When a user initiates a refund, the components automatically call Adyen's API to process the refund request. This means that no additional actions are needed on your part as a platform.
The transaction components support both full and partial refunds depending on the [payment method](/payment-methods). For partial refunds, users can issue multiple smaller refunds through the components, as long as the total amount of these refunds does not exceed the original payment amount.
The user flow for processing a refund through the components is as follows:
1. In the payment details, the user selects the **Refund payment** button.
2. In the **Refund payment** modal window, the user specifies a reason for the refund and the refund amount.
3. The user confirms their refund request.
4. After the refund request is processed, users can view the refund status message and label in the payment details.
The following tabs illustrate the user flow when processing a partial refund for a specific payment transaction:
### Tab: Payment details
[](/user/pages/filters/pe-components-dashboards/transactions/1-10-0/refund-user-flow/payment-details.png)
### Tab: Refund details
[](/user/pages/filters/pe-components-dashboards/transactions/1-10-0/refund-user-flow/refund-details.svg)
### Tab: Refund sent
[](/user/pages/filters/pe-components-dashboards/transactions/1-10-0/refund-user-flow/refund-sent.svg)
### Tab: Refund status
[](/user/pages/filters/pe-components-dashboards/transactions/1-10-0/refund-user-flow/refund-status.png)
After the refund has been issued and processed, users can view the refund transaction in their overview. Each refund transaction is linked to the corresponding payment transaction, making it easy for users to find relevant references and navigate between transaction records.
## How it works
The integration of components involves both server-side and client-side processes. You can find more details on the [component libraries](#see-also) page.
### Integration steps
Follow these steps to integrate the component(s):
1. [Create an authentication session from your server](#create-token)
2. [Install component library in your front end](#install-library)
3. [Initialize components](#initialize-components)
4. [Optional: Localize components](#localize-components)
5. [Optional: Customize component appearance](#customize-appearance)
6. [Optional: Customize component data](#customize-data)
### Create A Session
## 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](https://docs.adyen.com/api-explorer/sessionauthentication/latest/post/sessions) request specifying the following parameters:
To make this API request, your API key must have the **Transactions Overview Component: View** role in your Customer Area. For more information, refer to the [Requirements](#requirements) section.
| Parameter | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [allowOrigin](https://docs.adyen.com/api-explorer/sessionauthentication/latest/post/sessions#request-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. |
| [policy](https://docs.adyen.com/api-explorer/sessionauthentication/latest/post/sessions#request-policy) |  | An object that contains:- [resources](https://docs.adyen.com/api-explorer/sessionauthentication/latest/post/sessions#request-policy-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](https://docs.adyen.com/api-explorer/sessionauthentication/latest/post/sessions#request-policy-resources-type): The type of resource. Set this to **accountHolder**.
- [roles](https://docs.adyen.com/api-explorer/sessionauthentication/latest/post/sessions#request-policy-roles): The role required to use the component. Set this to **Transactions Overview Component: View**. To enable users to process refunds through the components, include the **Transactions Overview Component: Manage Refunds** role in your request. |
| [product](https://docs.adyen.com/api-explorer/sessionauthentication/latest/post/sessions#request-product) |  | The type of product the component belongs to. Set this to **platform**. |
Here is an example request for creating a session token.
**Create a session token**
```bash
curl https://test.adyen.com/authe/api/v1/sessions \
-H 'content-type: application/json' \
-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \
-d '{
"allowOrigin":"YOUR_DOMAIN",
"product":"platform",
"policy": {
"resources": [
{
"accountHolderId": "AH00000000000000000000001",
"type": "accountHolder"
}
],
"roles": [
"Transactions Overview Component: View",
"Transactions Overview Component: Manage Refunds"
]
}
}'
```
2. Note the API response. Later, when [initializing the components](#initialize-components), you need to create and call a function that passes the entire session object from the response to your front end.
**Session token created**
```json
{
"id": "EC1234-1234-1234-1234",
"token": "xxxxx.yyyyy.zzzzzz"
}
```
### Install Component Library
## 2. Install component library in your front end
Use the Adyen Web npm package, or embed the Adyen Platform Experience script and stylesheet into your HTML file:
### Tab: npm (recommended)
Install the **Adyen Platform Experience** library in your front-end application as follows:
1. Install the npm package.
```bash
npm install @adyen/adyen-platform-experience-web
```
2. Import the library, the components, and the style sheet.
```bash
import { AdyenPlatformExperience, component_name } from '@adyen/adyen-platform-experience-web';
import "@adyen/adyen-platform-experience-web/adyen-platform-experience-web.css";
```
### Tab: Embed script and stylesheet
Use the `integrity` attribute so browsers can verify that the script and stylesheet have not been changed unexpectedly.
The value of the `integrity` attribute is the [Subresource Integrity (SRI) hash](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) which Adyen provides for each version of the Adyen Web JavaScript and CSS files.
Get the SRI hashes from the [release notes](/release-notes/platforms-and-financial-products) for the Platform Experience components, under **Updating to this version**.
**embed-script-stylesheet.html**
```html
```
### Initialize Components
## 3. Initialize 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 |
| --------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `availableTranslations`Deprecated | | **Deprecated.** This field is no longer needed because locales are now dynamically loaded on demand via CDN. Setting this field will trigger a deprecation warning. An array containing the names of the imported locale files used for localizing the components. For example, `[es_ES, nl_NL, fr_FR]`. |
| `environment` | | Specifies the environment for the component integration. The default value is **test**. Set the parameter to **live** when you are ready to go live. |
| `locale` | | Specifies the locale code, which determines the desired language of the components. This code must correspond to a [supported language](#supported-languages). For example, use **es-ES** for Spanish. |
| `onSessionCreate` |  | The callback function that retrieves an authentication session token and refreshes the current session. |
2. Gather these parameters to initialize each component.
Select the tab for the component you want to use:
### Tab: Transactions Overview component
| Parameter | Required | Description |
| --------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowLimitSelection` | | Determines whether the user can change the number of transactions shown per page. Default value: **true**. |
| `core` |  | The instance of the library. |
| `dataCustomization` | | An object that contains both the `list` and `details` objects, which include [customization specifications](#customize-data) for dashboard fields, allowing for additional data integration from your database. |
| `onRecordSelection` | | If defined, the event allows obtaining the transaction ID when the user selects a specific transaction from the overview. You can use the obtained ID value to show the **Transaction Details** component in a different location within your portal's UI, outside the **Transactions Overview** component. |
| `preferredLimit` | | The number of transactions shown per page. Default value: **10**. |
### Tab: Transaction Details component
| Parameter | Required | Description |
| ------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `core` |  | The instance of the library. |
| `dataCustomization` | | An object that contains the `details` object, which include [customization specifications](#customize-data) for dashboard fields, allowing for additional data integration from your database. |
| `id` |  | The unique identifier of the transaction. |
2. Create a DOM element on your portal's UI page where you want the component to be rendered.
Assign the element a unique and descriptive ID. This unique ID is important to avoid any misconfigurations when integrating multiple components into your portal's UI.
By default, the **Transaction Details** component is shown as a modal window within the **Transactions Overview** component. In this scenario, you only need to create a DOM element for the **Transactions Overview** component. If you want to use the **Transaction 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:
### Tab: Transactions Overview component
**Create DOM element**
```html
```
### Tab: Transaction Details component
**Create DOM element**
```html
```
3. Add a function that [calls your API](#create-token) to retrieve and refresh an authentication session token.
The following code is the same for both transaction components.
**Add function to retrieve and refresh an authentication session token**
```bash
async function handleSessionCreate() {
const response = await fetch('YOUR_IMPLEMENTATION_OF_CREATE_SESSION_ENDPOINT');
return response.json();
}
```
4. Initialize the component and mount it to the container you created.
Be sure to include the function for retrieving and refreshing the session token that you added in the previous step.
To implement the **Transaction Details** component as a modal window within the **Transactions Overview** component, use the following code examples. In this implementation, when a user selects a specific transaction from the overview page, the transaction ID is automatically passed to the **Transaction Details** component, and the modal window opens.
Select the tab for the component you want to use:
### Tab: Transactions Overview component
**Initialize library and create component**
```javascript
import { AdyenPlatformExperience, TransactionsOverview } from '@adyen/adyen-platform-experience-web';
import "@adyen/adyen-platform-experience-web/adyen-platform-experience-web.css";
const core = await AdyenPlatformExperience({
onSessionCreate: handleSessionCreate,
});
const transactionsOverview = new TransactionsOverview({ core });
transactionsOverview.mount('#transactions-overview-container');
```
### Tab: Transaction Details component
**Initialize library and create component**
```javascript
import { AdyenPlatformExperience, TransactionDetails } from '@adyen/adyen-platform-experience-web';
import "@adyen/adyen-platform-experience-web/adyen-platform-experience-web.css";
const core = await AdyenPlatformExperience({
onSessionCreate: handleSessionCreate,
});
const transactionDetails = new TransactionDetails({
core,
id: 'ABCDEFG1234567890'
});
transactionDetails.mount('#transaction-details-container');
```
5. (Optional) To use the **Transaction Details** component outside of the **Transactions Overview** component:
1. Define the `onRecordSelection` callback.
**Define onRecordSelection callback**
```javascript
const transactionsOverview = new TransactionsOverview({
core,
onRecordSelection: ({ id }) => {
// Use selected transaction id.
}
});
```
2. Initialize the **Transaction Details** component using the `id` from the object argument as shown below.
**Link to the selected record**
```javascript
const transactionDetails = new TransactionDetails({
core,
id: ''
});
```
### Localize Components
## 4. Optional: Localize components
During the [component initialization](#initialize-components), you can also configure the components to use one of the [supported languages](#supported-languages).
Update your code for initializing components to include the localization settings. If no localization settings are provided, the components will default to English.
**Localize components**
```javascript
import { AdyenPlatformExperience } from '@adyen/adyen-platform-experience-web';
const core = await AdyenPlatformExperience({
locale: 'es-ES', // See supported languages for possible values
/* ... */
});
```
### Customize Appearance
## 5. Optional: Customize component appearance
The transaction 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 settings:
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.
### Tab: Example 1: Override CSS variables
**style.css**
```bash
:root {
--adyen-sdk-border-radius-s: 10px;
--adyen-sdk-border-radius-m: 20px;
--adyen-sdk-border-radius-l: 30px;
--adyen-sdk-color-background-disabled: #9ecdb1;
--adyen-sdk-color-background-inverse-primary: #0abf53;
--adyen-sdk-color-background-inverse-primary-hover: #57d389;
--adyen-sdk-color-decorative-blue: #0abf53;
--adyen-sdk-color-outline-primary-active: #0abf53;
}
```
### Tab: Example 2: Update CSS class settings
**style.css**
```bash
.adyen-pe-modal {
border-left: 3px solid #0abf53;
border-radius: 0;
height: 100%;
max-height: unset;
right: 0;
}
```
### Customize Data
## 6. Optional: Customize component data
The transaction components allow you to include a diverse range of data types and sources to showcase within your user dashboard. You can:
* Integrate custom data, such as your own fields, icons, links, and buttons.
* Define the settings for each dashboard field, including their names and visibility.
When initializing your component:
1. Specify the `dataCustomization` parameter, including:
### Tab: Transactions Overview component
| Parameter | Required | Description |
| --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list` | | An object that includes customization settings for dashboard fields in the transactions overview. Example: `dataCustomization: { list: { } }` |
| `details` | | An object that includes customization settings for dashboard fields in the transaction details view. Example: `dataCustomization: { list: { }, details: { } }` |
### Tab: Transaction Details component
| Parameter | Required | Description |
| --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `details` | | An object that includes customization settings for dashboard fields in the transaction details view. Example: `dataCustomization: { details: { } }` |
2. Within the `list` and/or `details` objects, define the customization settings, such as field names or visibility.\
You can customize the default fields and add custom fields. In the dashboard, custom fields will be positioned immediately after the default fields.
### Tab: Transactions Overview component
| Parameter | Required | Description |
| ---------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `fields` |  | Defines the settings of dashboard fields in the transactions overview. Default fields: **'createdAt'**, **'paymentMethod'**, **'transactionType'**, **'currency'**, **'amount'**, **'grossAmount'**. Example: `dataCustomization: { list: { fields: [] }, details: { fields: [] } }` |
| `onDataRetrieve` | | The callback function that retrieves a `Promise` object resolved with an array of the transaction records extended with custom data. Example: `dataCustomization: { list: { fields: [], onDataRetrieve: () => { } }, details: { fields: [], onDataRetrieve: () => { } } }` |
### Tab: Transaction Details component
| Parameter | Required | Description |
| ---------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fields` |  | Defines the settings of dashboard fields in the transaction detail view. Default fields: **'account'**, **'refundReason'**, **'id'**, **'merchantReference'**, **'pspReference'**, **'paymentPspReference'**, **'refundPspReference'**. Example: `dataCustomization: { details: { fields: [] } }` |
| `onDataRetrieve` | | The callback function that retrieves a `Promise` object resolved with the extended transaction record that contains custom data. Example: `dataCustomization: { details: { fields: [], onDataRetrieve: () => { } } }` |
1. Define the settings for each dashboard field using the following parameters.
| Parameter | Type | Required | Description |
| ------------ | ------ | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `align` | String | | Determines how the content in a field is aligned. Possible values: **left**, **center**, **right**. If not specified, it defaults to **left**. Example: `{ key: 'amount', align: 'right' }` |
| `flex` | Number | | Determines the width of a field in relation to other fields. It uses a numeric value that represents the [flex-grow](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow) factor in the CSS Flexbox layout. A higher value means that the field occupies more space compared to others. If not specified, it defaults to **1**. Example: `{ key: '_store', flex: 2 }` |
| `key` | String |  | Specifies the name of a field. Example: `fields: [ { key: '_store' } ]` To prevent conflicts with the default field names, always start the names of your custom fields with an underscore (\_) character. |
| `visibility` | String | | Determines whether a field should be shown or not. Possible values: **visible**, **hidden**. If not specified, it defaults to **visible**. Example: `{ key: 'amount', visibility: 'hidden' }` |
2. If adding a custom field, include the `onDataRetrieve` parameter.
**\`onDataRetrieve\` parameter**
```javascript
{
onDataRetrieve: async (data) => {
const ids = data.map(transaction => transaction.id);
const extendedData = await getMyDataByIds(ids);
return extendedData;
},
}
```
Make sure to include the received data object in the return object by using the [spread syntax](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax). The component can then use this as matching keys to map your custom data with the existing one.
**\`additionalData\` object**
```javascript
{
details: {
fields: [
{ key: '_store' },
],
onDataRetrieve: (data) => {
return {
...data,
_store: 'Amsterdam',
};
},
},
}
```
3. Specify the type of your custom data.
| Parameter | Type | Required | Description |
| --------- | ------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | String |  | Determines how the custom data value should look and behave. Possible values: **text**, **icon**, **link**, **button**. If not specified, it defaults to **text**. |
### Tab: Text
**\`text\` data type**
```javascript
{
list: {
fields: [
{ key: '_store' },
],
onDataRetrieve: (data) => {
return [
{
...data[0],
_store: {
type: 'text',
value: 'New York',
config: {
className: 'my-class my-class--variant',
},
},
},
{
...data[1],
_store: {
type: 'text',
value: 'New York',
config: {
className: 'my-class my-class--variant',
},
},
},
];
},
},
}
```
### Tab: Icon
**\`icon\` data type**
```javascript
{
list: {
fields: [
{ key: '_store' },
],
onDataRetrieve: (data) => {
return [
{
...data[0],
_store: {
type: 'icon',
value: 'New York',
config: {
src: '',
alt: '',
className: 'my-class my-class--variant',
},
},
},
{
...data[1],
_store: {
type: 'icon',
value: 'New York',
config: {
src: '',
alt: '',
className: 'my-class my-class--variant',
},
},
},
];
},
},
}
```
### Tab: Link
The target should accept both `_self` and `_blank`. The default option is `_blank`.
**\`link\` data type**
```javascript
{
list: {
fields: [
{ key: '_store' },
],
onDataRetrieve: (data) => {
return [
{
...data[0],
_store: {
type: 'link',
value: 'New York',
config: {
href: '',
target: '_self',
className: 'my-class my-class--variant',
},
},
},
{
...data[1],
_store: {
type: 'link',
value: 'New York',
config: {
href: '',
target: '_self',
className: 'my-class my-class--variant',
},
},
},
];
},
},
}
```
### Tab: Button
**\`button\` data type**
```javascript
{
list: {
fields: [
{ key: '_store' },
],
onDataRetrieve: (data) => {
return [
{
...data[0],
_store: {
type: 'button',
value: 'New York',
config: {
action: () => {},
className: 'my-class my-class--variant',
},
},
},
{
...data[1],
_store: {
type: 'button',
value: 'New York',
config: {
action: () => {},
className: 'my-class my-class--variant',
},
},
},
];
},
},
}
```
Here is an example `dataCustomization` object:
### Tab: Transactions Overview component
**Example \`dataCustomization\` object**
```javascript
{
dataCustomization: {
list: {
fields: [
{ key: '_store' },
{ key: 'createdAt', visibility: 'hidden' },
],
onDataRetrieve: async (transactions) => {
return getCustomTransactionsData(transactions);
},
},
details: {
fields: [
{ key: 'transactionType', visibility: 'hidden' },
{ key: 'amount', visibility: 'hidden' },
{ key: '_store' },
],
onDataRetrieve: async (transaction) => {
return getCustomTransactionData(transaction);
},
},
},
}
```
### Tab: Transaction Details component
**Example \`dataCustomization\` object**
```javascript
{
dataCustomization: {
details: {
fields: [
{ key: 'id', visibility: 'hidden' },
{ key: '_store' },
{ key: '_product' },
{ key: '_summary' },
{ key: '_country' },
],
onDataRetrieve: transaction => {
return getCustomTransactionDataById(transaction);
},
},
}
}
```
3. Make sure to include translations for your custom fields in the library initializer:
* If you are not localizing components, add the custom field translations for `en_US`.
* If you are localizing components, also include the appropriate custom field translations for all supported locales.
**\`translations\` object**
```javascript
const core = await AdyenPlatformExperience({
translations: {
en_US: {
_store: 'Store',
},
es_ES: {
_store: 'Tienda',
},
}
});
```
## Supported languages
You can set one of the following languages to localize any of the Platform Experience components.
| Language | Locale code | Locale file |
| --------------- | ----------- | ----------- |
| Danish | **da-DK** | **da\_DK** |
| Dutch | **nl-NL** | **nl\_NL** |
| English | **en-US** | **en\_US** |
| Finnish | **fi-FI** | **fi\_FI** |
| French | **fr-FR** | **fr\_FR** |
| German | **de-DE** | **de\_DE** |
| Italian | **it-IT** | **it\_IT** |
| Norwegian | **no-NO** | **no\_NO** |
| Portuguese (BR) | **pt-BR** | **pt\_BR** |
| Spanish | **es-ES** | **es\_ES** |
| Swedish | **sv-SE** | **sv\_SE** |
## See also
* [Component libraries](/platforms/components-overview)