Create Invoice
Invoices
Create Invoice
Create a new invoice and return a payment URL the customer opens to pay
POST
Create Invoice
Creates an invoice and returns the full invoice object together with a
payment_url the customer opens to complete payment.
Request at least $1. Because of how private transactions settle, every invoice total should be a minimum of $1. If you need to charge less than $1, contact us first.
Request Body
"public" or "private". Private mode uses stealth addresses. Defaults to your account’s privacy setting.Private invoices require that you have already registered private payments for the coin you want to receive in the Shakesco app. Without that setup, a "private" invoice fails at payment time.Currency code for the invoice amount (e.g.
"USD", "KES"). See all codesLine items (at least one required)
Customer’s email address. Omit or pass
null for walk-in customers.Customer’s display name (optional)
Two-letter country code of the payer (optional)
Tax percentage (e.g.
16 for 16%). Defaults to 0.Optional array of store item objects to link catalogue items to this invoice.
Preferred payment asset:
"BTC", "ETH", "USDT", or "SATS". Can be deferred and set by the payer.We recommend receiving "USDT" or "SATS": both settle fast and cheap. For "USDT", use a private invoice where possible so your financial activity stays confidential.Optional URL the customer is sent to after they finish paying. Must be a valid URL. Use it to return the payer to your own confirmation or order page.
Response
Returns the full invoice object with line items.Unique invoice identifier (e.g.
"INV-2026-a1b2c3d4")Encrypted URL the customer opens to complete payment
"pending" on creationInvoice currency code
Tax percentage applied
ISO 8601 datetime after which the invoice expires
Deferred. Set to
null until the payer initiates payment.Payment asset,
null until chosen by the payerThe redirect URL you supplied, or
null if none was setWhether the transaction originated from the Shakesco store.
true for store transactions, false for a standard invoice you created through the API, and null when it does not apply. Use this to tell store sales apart from your own invoices.Line items on the invoice. Each has
description, unit, price, and image.