Skip to main content
GET
Read one exact payment batch including older settled history

Authorizations

Authorization
string
header
required

Firebase ID token from an interactive portal session. Required for interactive operations (payroll, company settings, API-key management) and invoice decisions allowed by the member's review permissions.

Path Parameters

batch_id
string
required
Required string length: 1 - 300

Query Parameters

customer_id
string

Target company. Optional — API keys are pinned to one company, and single-company sessions default to it.

Response

Exact current batch and paying-account readiness.

customer_id
string
required
viewer_role
string
required
batch
object
required
payment_setup_ready
boolean
required
payment_verification_pending
boolean
required