Create an invoice
A one-off USD invoice, in the mode of the API key. Open a checkout session for it to collect payment. At most $100,000.00. Lightning carries at most $1,000.00, so a checkout above that does not offer it.
Authorization
ApiKey AuthorizationBearer <token>
A merchant API key, sent as Authorization: Bearer vk_live_…. The prefix
selects the mode: vk_test_ for testnets, vk_live_ for real money.
In: header
Header Parameters
Idempotency-Key*string
Makes the request safe to retry: the same key replays the first response instead of repeating the effect. At most 255 characters.
Length
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/invoices" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "amount": "string" }'{ "object": "invoice", "id": "string", "livemode": true, "status": "open", "amount": "string", "currency": "usd", "description": "string", "customer": "string", "customer_email": "string", "metadata": { "property1": "string", "property2": "string" }, "payments": [ { "object": "payment", "id": "string", "checkout_session": "string", "asset": "USDT", "network": "tron", "amount": "string", "status": "detected", "tx_hash": "string", "detected_at": "2019-08-24T14:15:22Z", "confirmed_at": "2019-08-24T14:15:22Z" } ], "paid_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z"}