Skip to main content
POST
Refund a payment

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

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

Order ID

payment_id
string<uuid>
required

Body

application/json
amount
integer

Refund amount in CENTS (integer, Stripe-parity). Example: 1500 = $15.00. Sending 15.00 (a float) returns 400 INVALID_AMOUNT. Omit for full refund.

Required range: x >= 1
Example:

1500

reason
enum<string>
Available options:
duplicate,
fraudulent,
customer_complaint,
other

Response

Refund created

The response is of type object.