Skip to main content
POST
Void a vendor prepayment

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.

Headers

Idempotency-Key
string

Optional idempotency key; a retry returns the first result.

Path Parameters

id
string<uuid>
required

Vendor prepayment UUID.

Body

application/json
reason
string | null
effective_date
string<date> | null

Response

The prepayment was voided (or, on a retried key, the first result).

data
object
idempotent_replay
boolean