Skip to main content
GET
List all public payment methods

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.

Response

Active payment methods.

id
string
required

Pass as paymentMethodId when creating payments/deposits.

name
string
required
Example:

"Bitcoin"

type
string
required

Method category (e.g. crypto, balance).

status
enum<string>
required
Available options:
active,
inactive,
maintenance
description
string
instructions
string
imageUrl
string
ranking
integer

Display order (lower = higher).

feeInfo
string

Human-readable fee hint (informational only).

minAmountUSD
number

Minimum checkout total (USD) to use this method; 0 = none.

tag
string | null
Example:

"Recommended"

tagColor
string | null
tagTextColor
string | null
network
string | null
Example:

"Bitcoin"

identifier
string | null

Sub-method identifier (internal routing).

symbol
string | null
Example:

"BTC"

coinImageUrl
string | null
memoRequired
boolean

True when payments need a memo/destination tag (XLM/XRP).

refundable
boolean
minRefundAmountUSD
number
refundDescription
string | null
refundNotes
string | null