Send paymentsPay Out concepts

Pay Out batches overview

Understand how a Pay Out batch moves from open to paid, and what each batch status means
View as MarkdownOpen in Claude
Applies to:PartnersPaypoints

A batch is a group of vendor payout transactions processed and funded together. Each batch carries a single status that reflects where it’s at in its lifecycle, from collecting payouts to being fully paid out to vendors.

This page covers batch status and what each status means. For how individual payout transaction statuses relate to the batch they’re in, see Pay Out schemas.

Batch statuses

These statuses appear in the Payabli Portal and the API. They describe a money out batch’s status.

StatusKeyDescriptionEvents
Open0The batch is open and hasn’t started processing yet.None
Closed1The batch is closed and sent to be processed. Captured payouts can’t be canceled at this point.Approved Payment Group, Waiting Funds
Funded2Money has been received from the funding entity (typically the paypoint).Funded
Processed3All payout requests in the batch have a payment type defined for the vendor, and the payments have been sent.Payment Group Processed
Paid4All payout transactions in the batch have been marked as Paid.Paid
Canceled-1The batch has been canceled.Cancelled

If you are working with money out endpoints in the API, the Key is returned as BatchStatus. For example, a response body that includes batch data looks like this:

Example batch response
// Example truncated to show the most relevant fields
{
"Records": [
    {
      "IdBatch": 100,
      "BatchDate": "2023-05-05T00:00:00",
      "BatchNumber": "187-20230505-EXAMPLEBATCH",
      "BatchStatus": 1,
      "BatchStatusText": "Waiting Funds",
 ...
    }
  ]
}

The value of BatchStatus indicates the status. In the example, the BatchStatus is 1, which means it’s closed. The BatchStatusText returns the most recent event for that status.

A batch starts Open and collects captured payouts until it closes automatically at your paypoint’s daily cutoff. Once Closed, payouts can no longer be added or canceled.

The cutoff time, and what canceling a payout looks like before and after it, both depend on whether you’re on managed payables or on-demand payouts. See Understanding payables and Understanding managed payables for the specifics of each program.

When the batch is Funded, money has been received from the funding entity — typically the paypoint. The payouts are then sent to vendors, and the batch status changes to Processed. A batch reaches Paid once every payout transaction in it has a status of Paid. For what each payout transaction status means, see Payout transaction statuses.

Canceled is a defined batch status, but no current UI or API action moves a batch into it directly. Canceling a payout in an open batch removes that payout from the batch instead of canceling the batch itself — the batch continues with its remaining payouts.

Batch grouping

Payouts group into batches by payment method — the underlying rail, such as ACH, check, wire, or Real-Time Payments (RTP) — not by payment speed. Payment Speed is a label derived from the payout’s method, not an independent grouping driver. For how long each method typically takes to reach a vendor, see the payout timeline reference.

See these related resources to help you get the most out of Payabli.