Skip to main content
POST
Refund 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<uuid>

Optional idempotency key.

Path Parameters

id
string<uuid>
required

Vendor prepayment UUID.

Body

application/json
refund_amount
number<double> | null

Amount to refund. If omitted, refunds the full unapplied balance.

reason
string | null

Human-readable reason for the refund (e.g., "Vendor declined the order").

Response

Prepayment refunded

data
object