Skip to main content
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

Create Payee

Register a new payee before initiating a payment.

Update Payee

Modify the payee name or associated metadata.

Get Payee

Retrieve a specific payee by ID.

List Payees

Retrieve all payees associated with a user.

Delete Payee

Remove an existing payee record.

​
Typical Integration Flow

1

1. Create a payee

Call Create Payee with the user ID, name, and contact details.
2

2. Store the payee ID

Persist the returned payee_id in your system for future transactions.
3

3. Reference the payee during payment creation

Provide the payee_id when calling payment endpoints.
4

4. Maintain payee accuracy

Update or delete payees as recipient information changes.

​
Best Practices

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