Invoice
Create Invoice
Endpoint for creating invoices
Introduction
The Invoice endpoint allows you to create a checkout experience for your customers.
In the request, you may specify the payment amount, currency, due date, and other metadata.
HTTP Request
POST /api/invoice
Request headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Authorization | <API Key> |
Request body
| Field | Type | Description |
|---|---|---|
| amount | number | Fiat amount to charge (positive). Required. |
| fiat_currency | string | 3-letter ISO fiat currency code (e.g. USD). Required. |
| wallet_address | string | null | Destination wallet address (min 5 chars). Optional. |
| coin_symbol | string | null | Cryptocurrency symbol (e.g. BTC). Required if wallet_address provided. |
| memo | string | null | Short note for internal or display use. Optional. |
| due_at | string | null | Future due date/time (ISO 8601). Optional. |
| invoice_message | string | null | Longer customer-facing message. Optional. |
| invoice_title | string | null | Custom invoice title. Optional. |
| client_email | string | null | Customer email (validated). Optional. |
| client_name | string | null | Customer name. Optional. |
{
"amount": 25.00,
"fiat_currency": "USD"
}Code examples
curl --location 'https://wayout.gg/api/invoice' \
--header 'Content-Type: application/json' \
--header 'Authorization: <API Key>' \
--data '{
"amount": 25.00,
"fiat_currency": "USD"
}'API key must have
Automate Payments permission
scope or higher.Response
In return, you will receive an invoice ID and a payment URL to direct your customer to, in order to make payment.
{
"success": true,
"invoice": {
"id": 12345,
"share_token": "<Share Token>",
"created_at": "2025-11-11T11:11:00.000Z",
"pay_url": "https://point-of-sale-domain/pay-invoice?share_token=<Share Token>"
}
}Store the invoice ID and share token for future reference.
You will need to be able to grant access to your product or service based on the association between the invoice ID and your customer.
When the invoice is paid, events will be sent to the applicable notification channels you have set up.