Skip to main content

Invoices

Invoice operations are currently exposed primarily through merchant-scoped billing routes.

The Invoice object​

{
  "id": "inv_abc123",
  "object": "invoice",
  "customer": "cus_xyz789",
  "status": "open",
  "currency": "xof",
  "amount_due": 175000,
  "amount_paid": 0,
  "due_date": "2026-03-15",
  "hosted_invoice_url": "https://invoice.ikawaari.com/inv_abc123",
  "created": 1708300800
}

Implemented route family​

Current merchant invoice routes include:

  • GET /api/v1/merchant/invoices
  • GET /api/v1/merchant/invoices/{id}
  • POST /api/v1/merchant/invoices
  • PATCH /api/v1/merchant/invoices/{id}/status
  • POST /api/v1/merchant/billing/wallet/invoices/{invoiceId}/apply

Legacy-compatible merchant paths may also be available under api/merchant/*.

List invoices​

GET /api/v1/merchant/invoices
ParameterTypeDescription
pageintegerPage number
limitintegerNumber of results per page
statusstringFilter by invoice status

Create an invoice​

POST /api/v1/merchant/invoices

Update invoice status​

PATCH /api/v1/merchant/invoices/{id}/status

Apply customer wallet to an invoice​

POST /api/v1/merchant/billing/wallet/invoices/{invoiceId}/apply

Integration note​

The current docs should treat invoices as part of the merchant billing surface unless a separate public invoice controller is explicitly exposed.