Adyen Dispute
The Adyen Dispute component (adyen-dispute) provides a dispute and chargeback management interface powered by Adyen's Platform Experience (PEX) SDK. It allows merchants to view, respond to, and resolve payment disputes from within the OnAccess platform.
Loaded via: Orchestrator Oc (requires CreditRisk approved + Adyen KYC active)
How It Works
The Orchestrator Oc authenticates and authorizes the user, then passes a signed JWT and organisation ID to this component. The component's server-side creates an Adyen session token using the merchant's account holder IDs, which the client-side Adyen PEX SDK then uses to render the dispute management UI.
Orchestrator Oc
|
| Passes authToken + evoOrganisationId
v
Adyen Dispute OC (server)
|
| Creates Adyen session for the merchant
| Resolves merchant's account holder IDs
v
Adyen Dispute OC (client)
|
| Initialises Adyen PEX SDK with session token
v
Adyen Platform Experience UI
|
| Renders dispute management interface
| Communicates directly with Adyen APIs
Parameters
All parameters are injected by the Orchestrator Oc. The host application does not pass these directly.
| Parameter | Type | Description |
|---|---|---|
evoOrganisationId | string | Tenant organisation ID, used to resolve account holder IDs |
authToken | string | Signed JWT (60-minute expiry) issued by the orchestrator API |
lang | string | UI language code (e.g. en) |
cultureCode | string | Locale for date/number formatting (e.g. en-GB) |
Permissions
The component renders different views based on the user's permissions (included in the JWT claims):
| Permission | View | Capabilities |
|---|---|---|
disputes-management | Dispute Management | Full dispute lifecycle management: view disputes, respond with evidence, update status, resolve disputes |
disputes-data | Disputes Overview | Read-only view of disputes with summary information and record selection |
If the user has neither permission, the component displays a restricted access message. At least one of these permissions must be present in the JWT for the component to render any content.
Features
Dispute Management View (disputes-management)
The full dispute management interface, rendered via Adyen's DisputeManagement PEX component. This provides:
- View all disputes across the merchant's account holders
- Respond to disputes with evidence and documentation
- Track dispute status and lifecycle
- Manage dispute resolution
Disputes Overview View (disputes-data)
A read-only overview rendered via Adyen's DisputesOverview PEX component:
- View dispute summaries
- Select individual disputes for inspection
- Paginated display (10 records per page, configurable page size)
Adyen Integration
The component integrates with Adyen using the Platform Experience Web SDK (@adyen/adyen-platform-experience-web).
Session-Based Authentication
The server-side creates an Adyen session for the client to use:
- The OC server receives the JWT and organisation ID
- It resolves the merchant's Adyen account holder IDs
- It calls the Adyen API to create a session token scoped to those account holders
- The client-side SDK uses this session token — it never has direct access to the Adyen API key
Environment Handling
The component automatically selects the correct Adyen environment:
| Deployment Environment | Adyen Environment |
|---|---|
| Development / CI / Stage | test |
| Production | live |
Error Handling
| Scenario | Behaviour |
|---|---|
Invalid or expired authToken | Displays an authentication failure alert with guidance to refresh the page |
Missing both disputes-management and disputes-data permissions | Displays a restricted access message |
| Adyen session creation failure | Displays a system error alert with support contact guidance |
| Adyen SDK initialization failure | Displays a system error alert |
All API calls are authenticated using the JWT passed by the Orchestrator Oc.