A net payout is one amount paid to a worker. A worker's net pay on a payment goes out as one or more payouts: one per bank account when it's split, or a payout to a pay card. The Net Payouts API lists the payouts on a company's payroll runs, so you can show workers what they were paid, and follow returns and retries.
| Endpoint | What it does |
|---|---|
| List net payouts | Lists the payouts on the company's payroll runs, newest first |
| Retrieve a net payout | Retrieves one payout |
The list is newest first and cursor-paginated, like every list in the Payroll Run API: see Listing and paging. Each run payment also lists its payouts in netPayouts. See List a payroll run's payments.
Filtering
Each filter takes several values, and matches any of them. Filters combine: a payout must match every filter you send.
| Parameter | Matches |
|---|---|
payment-id | The payouts on these payments |
payroll-run-id | The payouts in these payroll runs |
worker-id | The payouts to these workers, by Everee's workerId |
external-worker-id | The payouts to these workers, by your externalWorkerId |
status | The payouts with these statuses |
Types
type | How the money is paid | Details |
|---|---|---|
DIRECT_DEPOSIT | ACH to the worker's bank account | directDepositInfo: the account's nickname, routing number and last four digits |
REAL_TIME_PAYMENT | A real-time payment to the worker's bank account | |
PUSH_TO_CARD | A push to the worker's debit card | |
PAY_CARD | The worker's Everee pay card | payCardInfo: the card's last four digits |
CHECK | A check | |
EXTERNAL | Paid outside Everee |
Statuses
status | Meaning |
|---|---|
PENDING | Not paid yet |
PAID | Paid. A direct deposit is PAID from when it's submitted to the bank, since ACH never confirms that a deposit landed; it can still be returned later. Other types are PAID once they're delivered. |
RETURNED | The payout came back, for example because the bank account was closed |
SUPERSEDED | Replaced by another payout: a retry of a returned deposit, or a cash out |
Retries and cash outs
When a payout is replaced, the two are linked both ways:
- The replacement's
previousNetPayoutIdis the payout it replaced. - The replaced payout is
SUPERSEDED, and itssupersededByIdslists its replacements. A cash out can split one payout into several.
So a returned direct deposit that Everee retries reads as two payouts: the original, now SUPERSEDED with the retry in supersededByIds, and the retry, with the original in previousNetPayoutId. See Returned Deposits and Retries.
Webhook events
| Event | Sent when |
|---|---|
net-payout.paid | A payout becomes PAID |
net-payout.returned | A payout is returned |
net-payout.retried | A returned payout is retried. The event's payout is the one that was returned, now SUPERSEDED |
Each event's data.object is the net payout, as the API returns it. See Payroll Run Events.