Skip to main content
POST
Create (or refresh) the payment invoice 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.

Path Parameters

checkoutId
string
required

Checkout/order id.

Body

application/json
paymentMethodId
string
required
payCurrency
string

Override the invoicing currency (defaults to the checkout's paymentCurrency).

Response

Payment invoice created.

payment
object
required

Payment created for a checkout or deposit. Render the crypto invoice from paymentAddress + amount + currency (+ memo/ destinationTag when memoRequired), or redirect to paymentUrl for hosted providers. Refresh expired invoices by re-calling the payment endpoint.