Resolve an order overpayment
Resolves an order overpayment by routing the excess (refund to the
customer, apply as account credit, or hold as a deposit). The user_id
body field is required for the audit trail. Requires orders:write
scope. Idempotent via the Idempotency-Key header.
Authorizations
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
Client-generated unique key for idempotent POST/PATCH/DELETE operations. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. Pattern: or --.
255Path Parameters
Order UUID.
Body
Response
Overpayment resolved.
The response is of type object.

