Payees are the recipients of funds. A payee represents the individual or business you are sending money to, including their identity details, contact information, and payout methods. By creating and managing payees, you can reuse recipient information, reduce errors, and streamline payout workflows.Documentation Index
Fetch the complete documentation index at: https://docs.withacclaim.com/llms.txt
Use this file to discover all available pages before exploring further.
Why use payees
Using payees allows you to:- Store recipient details once and reuse them across payouts
- Validate information upfront to reduce failed payouts
- Support multiple payout methods per recipient
- Track payout history at the recipient level
How payees work
Payees are flexible and can be created in multiple ways:Create directly
Create a payee via API, file upload, or the Console by providing required identity and payout details.Collect details with payout links
If you don’t have full recipient details, you can create a payout and let Acclaim generate a payout link. The payee completes the link to:- Provide banking or payout details
- Select a preferred payout method (if enabled)
- Validate required information
Reuse across payouts
Once a payee exists, you can reference them in future payouts without re-entering details. This is useful for:- Vendors or partners paid repeatedly
- Policyholders receiving multiple disbursements
- High-volume payout workflows
Payee details
A payee typically includes:- Name (individual or business)
- Contact information (email, phone)
- Country and currency context
- Payout methods (bank account, local method, etc.)
Managing payout methods
A single payee can have multiple payout methods. For example:- A bank account for USD payouts
- A local payment method for another currency
- Add or update payout methods
- Set a default method
- Let the payee choose via payout link
Validation and errors
Acclaim validates payee details based on country and method requirements. This helps:- Prevent failed payouts
- Ensure compliance with local banking formats
- Catch missing or invalid information early
Updating payees
Payees can be updated at any time via API or the Console. Changes may:- Apply to future payouts
- Trigger re-validation of payout methods
- Require confirmation for certain fields