Enum MandateStatus 

pub enum MandateStatus {
    Created,
    ApprovalPending,
    ApprovalSucceeded,
    ApprovalFailed,
    RevocationPending,
    RevocationSucceeded,
    RevocationFailed,
    Canceled,
}

The most recent action on the mandate. status is an informational indicator of the latest transition; it is not the source of truth for what has durably happened. Read the timestamps for that: approvedAt, canceledAt, and revokedAt each record a durable milestone independently of status.

- `created`: the mandate exists but no approval has been attempted. No
  source attached. Not usable.


- `approval_pending`: an approval is in flight. Not usable. Emits
  `acceptance.mandate.approval_initiated`.


- `approval_succeeded`: the mandate has a source and is usable.

- `approval_failed`: the last approval attempt failed. Not usable. Submit
  a new approval to retry.


- `revocation_pending`: a wallet revocation is being confirmed on the
  network. Emits `acceptance.mandate.revocation_initiated`. Resolves to
  `revocation_succeeded` on success or `revocation_failed` on failure.


- `revocation_succeeded`: a wallet revocation removed the spending allowance
  on-chain (`revokedAt` is set). Terminal.


- `revocation_failed`: the last wallet revocation attempt did not complete.
  The spending allowance was not removed, so the mandate remains usable if it
  was usable before. Submit a new revocation to retry.


- `canceled`: the merchant ended the mandate off-chain (`canceledAt` is set).
  The on-chain spending allowance may still be live; a later wallet
  revocation can still move `status` through the `revocation_*` values and
  set `revokedAt`.


**Usable when** `approvedAt` is set, `canceledAt` is null, `revokedAt` is null, and `expiresAt` is null or in the future. Usability is derived from these timestamps, not from `status`: a failed revocation, for example, leaves `status` at `revocation_failed` but the mandate stays usable because the allowance was never removed. Authorization checks the durable conditions in order, and the first match wins: an in-flight approval or revocation returns `409` (`mandate_action_pending`); `revokedAt` set returns `422` (`mandate_revoked`); `canceledAt` set returns `422` (`mandate_canceled`); a past `expiresAt` returns `400` (`mandate_expired`); any other status returns `422` (`mandate_invalid_status`). Approve a mandate and get wallet approval options use that same order for the in-flight, revoked, canceled, and expired checks. Any other status except `created` or `approval_failed` returns `422` (`mandate_invalid_status`). Those rejections do not change the timestamps. Debit limits are enforced at authorization time.

JSON schema

{
 "description": "The most recent action on the mandate. `status` is an informational indicator of the latest transition; it is not the source of truth for what has durably happened. Read the timestamps for that: `approvedAt`, `canceledAt`, and `revokedAt` each record a durable milestone independently of `status`.\n\n- `created`: the mandate exists but no approval has been attempted. No\n  source attached. Not usable.\n\n\n- `approval_pending`: an approval is in flight. Not usable. Emits\n  `acceptance.mandate.approval_initiated`.\n\n\n- `approval_succeeded`: the mandate has a source and is usable.\n\n- `approval_failed`: the last approval attempt failed. Not usable. Submit\n  a new approval to retry.\n\n\n- `revocation_pending`: a wallet revocation is being confirmed on the\n  network. Emits `acceptance.mandate.revocation_initiated`. Resolves to\n  `revocation_succeeded` on success or `revocation_failed` on failure.\n\n\n- `revocation_succeeded`: a wallet revocation removed the spending allowance\n  on-chain (`revokedAt` is set). Terminal.\n\n\n- `revocation_failed`: the last wallet revocation attempt did not complete.\n  The spending allowance was not removed, so the mandate remains usable if it\n  was usable before. Submit a new revocation to retry.\n\n\n- `canceled`: the merchant ended the mandate off-chain (`canceledAt` is set).\n  The on-chain spending allowance may still be live; a later wallet\n  revocation can still move `status` through the `revocation_*` values and\n  set `revokedAt`.\n\n\n**Usable when** `approvedAt` is set, `canceledAt` is null, `revokedAt` is null, and `expiresAt` is null or in the future. Usability is derived from these timestamps, not from `status`: a failed revocation, for example, leaves `status` at `revocation_failed` but the mandate stays usable because the allowance was never removed. Authorization checks the durable conditions in order, and the first match wins: an in-flight approval or revocation returns `409` (`mandate_action_pending`); `revokedAt` set returns `422` (`mandate_revoked`); `canceledAt` set returns `422` (`mandate_canceled`); a past `expiresAt` returns `400` (`mandate_expired`); any other status returns `422` (`mandate_invalid_status`). Approve a mandate and get wallet approval options use that same order for the in-flight, revoked, canceled, and expired checks. Any other status except `created` or `approval_failed` returns `422` (`mandate_invalid_status`). Those rejections do not change the timestamps. Debit limits are enforced at authorization time.",
 "examples": [
   "approval_succeeded"
 ],
 "type": "string",
 "enum": [
   "created",
   "approval_pending",
   "approval_succeeded",
   "approval_failed",
   "revocation_pending",
   "revocation_succeeded",
   "revocation_failed",
   "canceled"
 ]
}

Variants

Created

ApprovalPending

ApprovalSucceeded

ApprovalFailed

RevocationPending

RevocationSucceeded

RevocationFailed

Canceled

Trait Implementations

impl Clone for MandateStatus

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MandateStatus

impl Debug for MandateStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MandateStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MandateStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for MandateStatus

impl From<&MandateStatus> for MandateStatus

fn from(value: &MandateStatus) -> Self

Converts to this type from the input type.

impl FromStr for MandateStatus

type Err = ConversionError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, ConversionError>

Parses a string s to return a value of this type.

impl Hash for MandateStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MandateStatus

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for MandateStatus

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for MandateStatus

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MandateStatus

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MandateStatus

impl TryFrom<&String> for MandateStatus

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<&str> for MandateStatus

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<String> for MandateStatus

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, ConversionError>

Performs the conversion.