Skip to main content
DELETE
Void a payment batch

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

batchId
string<uuid>
required

Body

application/json
reason
string

Operator-supplied void reason (audit-logged).

Response

Batch voided (or already voided no-op). Response body: { data: { id, status: 'voided', removed_payments: <count> } }.

data
object