Payout
Payout API
Methods
Section titled “Methods”- POSTDisburse a single payment (e.g.Disburse a single payment (e.g. an employee salary) to a bank account, on the tenant's OWN connected payout provider (paystack | stripe). amount is INTEGER MINOR UNITS (cents). Refuses if the tenant has no payout connection. Auth-required; tenant-scoped.
- POSTDisburse many payments in one run (e.g.Disburse many payments in one run (e.g. a full payroll). Paystack uses a native bulk transfer (requires OTP disabled on the tenant's account); Stripe loops. amounts are minor units. Auth-required; tenant-scoped.
- POSTGet a payout's current status (tenant-scoped read-back).Get a payout's current status (tenant-scoped read-back).
- POSTGet the tenant's payout provider balance / financial-account balance (feeds a float widget).Get the tenant's payout provider balance / financial-account balance (feeds a float widget). Auth-required; tenant-scoped.
- POSTList payouts for the current tenant (tenant-scoped).List payouts for the current tenant (tenant-scoped).
- POSTValidate a beneficiary bank account (AVS) on the tenant's payout provider before paying.Validate a beneficiary bank account (AVS) on the tenant's payout provider before paying. Paystack /bank/validate (costs the tenant a small fee per check). Auth-required; tenant-scoped.