v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Invoice

List the merchant's invoices (drafts are hidden — customers see ISSUED+ only)

get/api/v1/merchants/{merchantId}/invoices

Path parameters

merchantIdstring uuid required

The merchantId parameter

Query parameters

'draft'

'issued'

'paid'

'void'

Lifecycle status of the invoice

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "currency": "GBP",
      "total_amount": "1234.56",
      "amount_paid": "0.00",
      "outstanding_amount": "1234.56",
      "payments": [
        {
          "amount": "125.00",
          "currency": "GBP"
        }
      ],
      "fx_rates": [
        {
          "source_currency": "GBP",
          "rate": "0.85120000",
          "provider": "openexchangerates"
        }
      ]
    }
  ]
}