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

# Overview

> Create and manage reusable payee records for a specific user through the Paywint Developer API.

The **Payee Management API** allows you to create and manage reusable recipient records for a specific Paywint user.

A **payee** represents the recipient identity referenced during payment creation.\
This API manages recipient records.

***

## What This API Provides

The Payee API enables your integration to:

* Create a reusable payee tied to a specific user
* Store at least one verified contact method (email or phone with country code)
* Retrieve a payee by ID
* List all payees associated with a user (paginated)
* Update payee details
* Delete unused payees

Each payee must include:

* `name` (recipient display name)
* At least one contact method

An optional `metadata` field may be used to store application-specific reference data.

***

## Available APIs

<CardGroup cols={3}>
  <Card title="Create Payee" icon="user-plus" href="/api-reference/payees/create" arrow="true">
    Register a new payee before initiating a payment.
  </Card>

  <Card title="Update Payee" icon="pencil" href="/api-reference/payees/update" arrow="true">
    Modify the payee name or associated metadata.
  </Card>

  <Card title="Get Payee" icon="user" href="/api-reference/payees/get" arrow="true">
    Retrieve a specific payee by ID.
  </Card>
</CardGroup>

<CardGroup cols={3}>
  <Card title="List Payees" icon="list" href="/api-reference/payees/list" arrow="true">
    Retrieve all payees associated with a user.
  </Card>

  <Card title="Delete Payee" icon="trash" href="/api-reference/payees/delete" arrow="true">
    Remove an existing payee record.
  </Card>
</CardGroup>

***

## Typical Integration Flow

<Steps>
  <Step title="1. Create a payee">
    Call <code>[Create Payee](/api-reference/payees/create)</code> with the user ID, name, and contact details.
  </Step>

  <Step title="2. Store the payee ID">
    Persist the returned `payee_id` in your system for future transactions.
  </Step>

  <Step title="3. Reference the payee during payment creation">
    Provide the `payee_id` when calling payment endpoints.
  </Step>

  <Step title="4. Maintain payee accuracy">
    Update or delete payees as recipient information changes.
  </Step>
</Steps>

***

## Best Practices

* Validate email and phone format before submission.
* Avoid creating duplicate payees when an existing record can be reused.