API Reference

Payees

Onboard people, fetch their payout identity, and check whether they can be paid.

• get/api/v1/payeesList your payees
• post/api/v1/payeesCreate or update a payee
• get/api/v1/payees/{id}Get one payee
• post/api/v1/payees/{id}/methodsAdopt an existing provider account as a payout method
• post/api/v1/payees/{id}/onboarding-linkCreate a hosted onboarding link
• get/api/v1/payees/{id}/readinessCheck payout readiness
• get/api/v1/payees/{id}/balanceGet the payee's wallet balance
• post/api/v1/payees/{id}/portal-linkEmail the payee a hosted portal (wallet) link
• post/api/v1/payees/{id}/withdrawWithdraw the payee's held balance as one consolidated payout

Payouts

Create idempotent payouts and read their status.

• get/api/v1/payoutsList your payouts
• post/api/v1/payoutsCreate a payout
• post/api/v1/payouts/batchCreate many payouts in one call
• get/api/v1/payouts/{id}Get one payout
• post/api/v1/payouts/{id}/retryRetry a transiently-failed payout
• post/api/v1/payouts/{id}/releaseRelease a held payout

Disbursements

Push owed (IOU) rows programmatically — the API twin of the client-portal CSV upload.

• post/api/v1/disbursementsPush owed (IOU) rows
• post/api/v1/disbursements/recovery-linkLink released disbursements to their replacement payout

Webhooks

• HOOKpayee.updatedpayee.updated
• HOOKpayout.statuspayout.status