mandate-portal

Get Mandate Portal

Load public portal view for a mandate.

Returns balance, status, JWT token (if active), and last 10 charges. The mandate_id is the user's credential — treat it like an account number.

get/mandate/portal/{mandate_id}

Request

  • Base URL: https://api.algovoi.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://api.algovoi.co.uk/mandate/portal/{mandate_id}
  • Auth: none declared

Path parameters

mandate_idstring uuid required

Query parameters

include_tokenboolean

Include JWT token in response

tenant_idstring uuid nullable

Response

Successful Response

mandate_idstring uuid required
display_namestring required
balance_minorinteger required
currencystring required
periodstring required
period_cap_minorinteger required
period_spent_minorinteger required
statusstring required
tokenstring nullable
created_atstring date-time required
expires_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.