Create, find, and manage the people and businesses you pay.
A payee is a person or business that receives your payouts. Each payee belongs to your payor account and is identified by email and by your own reference ID (referenceId), which is unique within your account.
A payee is created when you create one directly, when you create a payment for a new email, or when you request a payee widget URL. The payee then completes onboarding (profile, tax information, and a payment method). Until onboarding is complete, the payee is not payable.
payable | Meaning |
|---|---|
true | The payee has completed onboarding. You can submit payments to them. |
false | The payee has not finished onboarding. Submitting fails, unless you use auto-submit, which waits until the payee becomes payable. |
Subscribe to the payee-payability-changed webhook event to learn when a payee becomes payable. See Payees and Onboarding and Payee Reference IDs.