Skip to main content
POST
Create an invoice

Authorizations

Authorization
string
header
required

API key from the Payoes dashboard (pk_test_... or pk_live_...)

Body

application/json
amount
string
required

Stellar amount with up to 7 decimal places

Pattern: ^\d+(\.\d{1,7})?$
Example:

"10.5"

customer_id
string
required

Customer public ID

description
string | null
Maximum string length: 500
metadata
object | null
due_in_days
integer

Days until due (default 30)

Required range: 1 <= x <= 365

Response

Invoice created

id
string
required
Example:

"inv_abc123xyz"

object
enum<string>
required
Available options:
invoice
invoice_number
string
required
Example:

"INV-000001"

status
enum<string>
required
Available options:
draft,
open,
paid,
void
amount
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
settlement_asset
object | null

From the linked payment after finalize (null on draft)

allowed_assets
object[]
description
string | null
metadata
object | null
customer_id
string | null
checkout_session_id
string | null
checkout_url
string<uri> | null
hosted_invoice_url
string<uri> | null

Public invoice page (/i/inv_...)

items
object[]
due_at
string<date-time> | null
paid_at
string<date-time> | null
sent_at
string<date-time> | null