Skip to main content
POST
Request a refund for a checkout

Authorizations

X-API-Key
string
header
required

API key (wg_live_…) created in the dashboard (Account → API Keys). Shown once at creation; only a hash is stored server-side.

Body

application/json
checkoutId
string
required

Response

Refund created (tied to the end-customer's email on the checkout).

Refund lifecycle record. Auto-refund to original payment methods is attempted first; any remainder proceeds through the refund-method flow (see status). Additional internal fields may be present.

id
string
required
checkoutId
string
required
totalAmount
number
required

Total eligible refund, in currency.

currency
string
required
status
enum<string>
required
Available options:
requested,
auto_processing,
awaiting_method,
processing,
completed,
failed,
admin_review,
cancelled_by_owner
createdAt
integer<int64>
required

Unix timestamp in milliseconds (UTC).

Example:

1753142400000

email
string

Refund identity (end-customer on retailer; your account email on B2B).

remainingAmount
number

Still to refund after auto-refunds.

items
object[]
autoRefunds
object[] | null
method
string | null

Chosen refund method (balance or a payment method).

initiatedBy
enum<string>
Available options:
user,
admin,
system
reason
string | null
retryCount
integer
completedAt
integer<int64> | null

Unix timestamp in milliseconds (UTC).

Example:

1753142400000

updatedAt
integer<int64>

Unix timestamp in milliseconds (UTC).

Example:

1753142400000