Endpoint Details
- Method:
POST
- URL:
/api/v0/invoices
- Content-Type:
application/json
- Authentication: Required (API Key & Secret)
- Rate Limiting: 100 requests per minute
- Idempotency: Supported (recommended for invoice creation)
Authentication
This endpoint requires API key authentication using:x-client-key
: Your API client keyx-client-secret
: Your API client secret
Request Parameters
Required Fields
Field | Type | Description | Example |
---|---|---|---|
name | string | Invoice name/title | ”Website Development Services” |
string | Customer email address | ”customer@example.com” | |
customer_id | string (UUID) | Existing customer identifier | ”550e8400-e29b-41d4-a716-446655440000” |
walletId | string (UUID) | Wallet for payment processing | ”abcd1234-5678-90ef-ghij-klmnopqrstuv” |
items | array | Products/services on the invoice | See item structure below |
due_date | string (date) | Payment due date (YYYY-MM-DD) | “2024-02-15” |
delivery | enum | Delivery method | ”EMAIL” or “MANUALLY” |
payment_link | boolean | Generate payment link | true |
payment_methods | array | Accepted payment methods | [“CRYPTO”, “BANK_TRANSFER”] |
status | enum | Invoice status | ”DRAFT” or “OPEN” |
partial_payment | boolean | Allow partial payments | false |
Optional Fields
Field | Type | Description | Example |
---|---|---|---|
address | string | Customer address | ”123 Business St, City, State” |
phone_number | string | Customer phone number | ”+1-555-123-4567” |
send_date | string (date) | Invoice send date (YYYY-MM-DD) | “2024-01-15” |
logo | string (URL) | Company logo URL | ”https://example.com/logo.png” |
taxId | string (UUID) | Tax configuration ID | ”tax_550e8400-e29b-41d4” |
currency | enum | Invoice currency | ”USDC” (default) |
Item Structure
Each item in theitems
array requires:
Field | Type | Description | Example |
---|---|---|---|
product_id | string (UUID) | Product identifier | ”prod_550e8400-e29b-41d4” |
quantity | number | Quantity of the product | 2 |
Enums
InvoiceStatus
InvoiceStatus
DRAFT
- Invoice is being preparedOPEN
- Invoice sent and awaiting paymentPAID
- Invoice has been paidPASTDUE
- Invoice is overduePARTIALLYPAID
- Partial payment received
DeliveryMethod
DeliveryMethod
EMAIL
- Send via email automaticallyMANUALLY
- Manual delivery/pickup
PaymentMethod
PaymentMethod
CRYPTO
- Cryptocurrency paymentsBANK_TRANSFER
- Bank transfer/ACHCREDIT_CARD
- Credit card paymentsCASH
- Cash paymentsMOBILE_MONEY
- Mobile payment methodsACH
- ACH transfers
Currency
Currency
USDC
- USD Coin (default)EURC
- Euro Coin