Group payments, set their defaults, and submit them together.
A batch is a container for payments. It supplies their defaults: payment category, tax jurisdiction, allowed payout methods, and denied countries. Each payment names the ledger account that funds it. Batch IDs start with B-.
Create a batch first, then add payments to it, then submit the payments one at a time or the whole batch at once. A batch has no status of its own. Its payments carry the status.
| State | Meaning |
|---|---|
archived: false | The batch accepts new payments, changes, and submissions. |
archived: true | The batch refuses new payments, changes (other than unarchiving), and submissions with 423. If a payment in it is returned, the batch is unarchived automatically. |
Batch totals and counts are calculated asynchronously, so they can lag a few seconds behind the payments. See Batches.