This includes contacts receiving payments through ACH, cards, wallet transfers, mailed checks, or any supported method. The Payee Management API allows you to store and maintain a user’s payment recipients so they can quickly send payments without re-entering details each time.
What This API Covers
With the Payee Management APIs, you can:- Create new payees for a user
- Store basic contact information such as name, email, and phone
- Update payee details
- Retrieve a specific payee
- List all payees associated with a user
- Remove a payee when no longer needed
Available APIs
Create Payee
Register a new payee under a specific user.
Update Payee
Modify the name of an existing payee.
Get Payee
Retrieve stored contact details for a specific payee.
List Payees
Fetch all payees created under a user, with pagination support.
Delete Payee
Remove a payee from the user’s contact list.
When Payees Are Used
Payees are used whenever a user sends a payment to another person or entity, including:- ACH or card-based payments
- Wallet-to-wallet transfers
- Mailed check payments
Manage Payee’s
1
1. Create a payee for the user
Use
Create Payee with the payee’s name and at least one contact method.2
2. Retrieve or list payees when preparing a payment
Before sending a payment, fetch a specific payee or list all payees for selection.
3
3. Update payee details when needed
The payee’s name can be modified using
Update Payee.4
4. Delete unused payees
If a payee is no longer relevant, remove them using
Delete Payee.Best Practices
- Require users to provide at least one reliable contact detail (email or phone)
- Display the payee name and contact details to confirm the correct recipient
- Encourage users to keep their payee list up-to-date
- Use pagination when listing payees for users with large recipient lists