Skip to content

Get eligible mandates

Mandates that can pay `amount` right now: signed, enabled, inside their window, matching currency, with enough remaining budget. Ordered by soonest expiry. `host` is echoed but does not filter.

GET
/api/mandates/eligible

Responses​

Eligible mandates (may be empty).

application/json

Eligible mandates.

Always ok.

Echo of the query.

{
  "status": "<string>",
  "criteria": {
    "host": "<string>",
    "amount": "<string>",
    "currency": "<string>"
  },
  "eligibleMandates": [
    {
      "mandateId": "<string>",
      "status": "<string>",
      "naturalLanguage": "<string>",
      "category": "<string>",
      "currency": "<string>",
      "limitAmount": "<string>",
      "spentAmount": "<string>",
      "pendingSpentAmount": "<string>",
      "remainingAmount": "<string>",
      "validFrom": "<string>",
      "validUntil": "<string>",
      "signedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "isEnabled": "<boolean>",
      "detailsUrl": "<string>",
      "signUrl": "<string>"
    }
  ]
}

Released under the MIT License.