Skip to main content
GET
Get deposit + payment state (poll until confirmed)

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.

Path Parameters

depositId
string
required

Deposit id (depb_…; older deposits may use dep_…).

Pattern: ^dep[br]?_

Response

Deposit detail. paymentState is null until a payment exists. availablePaymentMethods is present only while the deposit is still pending.

deposit
object
required
paymentState
object | null
required

Aggregate payment state across all payments on a checkout/deposit.

availablePaymentMethods
object[]