Skip to main content
POST
Create a balance top-up (optionally with payment invoice in one call)

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
amount
number
required

USD value to credit to your balance. Capped by tier maxDepositUSD.

Required range: x >= 0.1
Example:

500

paymentCurrency
enum<string>
required

Currency you will pay in.

Available options:
USD,
EUR,
GBP,
AUD,
CAD,
INR,
BTC,
LTC,
USDC,
USDT,
XRP,
XLM
paymentMethodId
string

Optional — also create the provider invoice in this call.

Response

Deposit created. With paymentMethodId: includes payment (invoice). Without: includes availablePaymentMethods.

deposit
object
required
paymentAmount
number
required

Amount due in paymentCurrency (USD amount converted, rounded up to 2 dp).

payment
object

Present when paymentMethodId was supplied.

availablePaymentMethods
object[]

Present when paymentMethodId was NOT supplied. Balance method excluded.