Sign in
Invoice
Admin

Preview claimable transactions for a (merchant, period) window. Uses the same eligibility predicate as create; surfaces conflicts when other invoices already own rows in the window. Used by the Create-invoice form to validate the window before submit.

Preview claimable transactions for a (merchant, period) window. Uses the same eligibility predicate as create; surfaces conflicts when other invoices already own rows in the window. Used by the Create-invoice form to validate the window before submit.

get/api/v1/admin/invoices/claimable

Query parameters

merchant_idstring uuid required

The merchant_id parameter

period_startstring date required

UTC date, inclusive

UTC date, inclusive

period_endstring date required

UTC date, exclusive

UTC date, exclusive

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "fee_totals_by_currency": [
      {
        "currency": "GBP"
      }
    ],
    "transactions": [
      {
        "deposit_currency": "GBP",
        "fee_currency": "GBP"
      }
    ]
  }
}

Changes

Changed in 2 of the 8 revisions of this API.11