> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paysway.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

The **Beneficiary Hub** lets your beneficiaries (the end‑users of your application) review and edit their payout methods through PaySway's smart, country‑aware forms.
We believe in asking only what's necessary, setting clear expectations, and reducing maintenance and development efforts for your team - so you can focus on your core product and not on ever‑changing payment rails.

Our operational model is:

<Steps>
  <Step title="Initiation">
    The process begins when an end-user opts to manage their payout methods within your application's interface.
  </Step>

  <Step title="Management session">
    Your application backend then requests a short-lived, secure management session from the PaySway API.
    This session is unique to the end-user.
    We return a URL that you use to redirect the end-user to.
  </Step>

  <Step title="User interaction">
    Once redirected, the end-user interacts directly with the PaySway Beneficiary Hub.
    Here, they can securely add, view, edit, or delete their payout methods.
    Our interface uses smart forms with dynamic validation and data enrichment to ensure accuracy and ease of use.
  </Step>

  <Step title="Synchronization">
    Your system stays updated with any changes through webhooks.
    The PaySway API can send notifications to your application, allowing you to retrieve the latest payout methods for your users as needed.
  </Step>
</Steps>

```mermaid theme={null}

sequenceDiagram
participant user as End-user
participant client_ui as Client UI
participant client_app as Client app
participant paysway_ui as PaySway-hosted UI
participant paysway_api as PaySway API

    user->>client_ui: Click 'Manage payout methods' button

    client_ui->>client_app: Request to manage payout methods
    client_app->>paysway_api: Generate short-lived management session (provides external user ID)
    paysway_api-->>client_app: Return short-lived session URL 
    client_app-->>client_ui: Return session URL to redirect to
    client_ui-->>user: Redirect to session URL

    user->>paysway_ui: Accesses management session 
    paysway_ui->>paysway_api: Authenticate user with session secret
    paysway_api-->>paysway_ui: Authentication successful

    paysway_ui-->>user: Display payout methods portal
    user->>paysway_ui: View/Add/Edit/Delete payout methods (smart forms, dynamic validation, enrichment)
    paysway_ui->>paysway_api: Send payout method changes (on save)
    paysway_api-->>paysway_ui: Confirm changes saved

    loop Asynchronous updates
        paysway_api-)client_app: Notify of payout method updates via webhooks
        
        client_app->>paysway_api: Retrieve updated payout method details for a user
        paysway_api-->>client_app: Payout method details

    end
```