GET
Get a batch
Step 5. Fetch the batch by its batchId to see the overall status and each item’s status (QUEUEDSUCCESS or FAILED). To list all of a customer’s batches, use GET /v1/batch-payments.

Counts and totals without opening each batch

Add includeItemSummary=true to the listing and each batch carries itemsStatus — its completed, pending, processing and failed counts — and totalAmount, the sum of its item amounts. That is enough to show progress for a page of batches without fetching every one of them. Leave the parameter off and both fields are absent; only the exact string true turns it on. It is opt-in because the counts are computed by reading each batch’s items, so ask for it on the page sizes you actually display rather than on a large limit you only want ids from.
Drafts have no item rows, so itemsStatus and totalAmount stay absent on ?drafts=true even with this parameter. paymentsCount is what a draft has instead.

Authorizations

Authorization
string
header
required

The caller's id_token from authentication — the ID token, not the access_token. The program and environment come from the token.

Path Parameters

batchId
string
required

The batch id from submit.

Response

The batch and its items

success
boolean
Example:

true

data
object