Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Invoice
Admin

Create a draft invoice for a merchant over a (period, currency) window. Claims eligible transactions atomically; pre-settled fees produce an immediately_settled payment row.

Create a draft invoice for a merchant over a (period, currency) window. Claims eligible transactions atomically; pre-settled fees produce an immediately_settled payment row.

post/api/v1/admin/invoices

Request body

merchant_idstring uuid required
period_startstring date required

UTC date, inclusive

period_endstring date required

UTC date, exclusive

currencystring required

ISO-4217 invoice currency (defaults to merchant home currency)

notesstring nullable

Example request

{
  "currency": "GBP"
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "invoice_number": "INV-202605-000001",
    "payment_reference": "QK7L2M9X4P0R",
    "currency": "GBP",
    "total_amount": "1234.56",
    "amount_paid": "0.00",
    "outstanding_amount": "1234.56",
    "transaction_count": 42,
    "payments": [
      {
        "amount": "125.00",
        "currency": "GBP"
      }
    ],
    "fx_rates": [
      {
        "source_currency": "GBP",
        "rate": "0.85120000",
        "provider": "openexchangerates"
      }
    ]
  }
}