Struct MandatePolicy 

pub struct MandatePolicy {
    pub max_per_authorization: Option<String>,
    pub max_per_period: Option<MandatePolicyPeriodCap>,
    pub min_setup_balance: Option<String>,
}

Debit caps in the mandate’s asset. Omit policy or send {} to default to a Coinbase-configured monthly max. Supplied amounts are capped at Coinbase ceilings. If you set maxPerPeriod, include both amount and period.

JSON schema

{
 "title": "Mandate Policy",
 "description": "Debit caps in the mandate's `asset`. Omit `policy` or send `{}` to default to a Coinbase-configured monthly max. Supplied amounts are capped at Coinbase ceilings. If you set `maxPerPeriod`, include both `amount` and `period`.",
 "examples": [
   {
     "maxPerAuthorization": "50.00",
     "maxPerPeriod": {
       "amount": "500.00",
       "period": "month"
     }
   }
 ],
 "type": "object",
 "properties": {
   "maxPerAuthorization": {
     "description": "Max amount for one authorization. Omit to use the Coinbase default. Capped at the Coinbase ceiling.",
     "examples": [
       "50.00"
     ],
     "type": "string"
   },
   "maxPerPeriod": {
     "description": "One rolling cap. Omit to use a Coinbase-configured monthly max. If set, both `amount` and `period` are required. Amount is capped at that period's ceiling.",
     "examples": [
       {
         "amount": "500.00",
         "period": "month"
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/MandatePolicyPeriodCap"
       }
     ]
   },
   "minSetupBalance": {
     "description": "Optional minimum available balance the payer must have to set up the mandate, denominated in the mandate's `asset`. When set, the mandate can only be approved if the payer's available balance is at least this amount; an approval attempted while the balance is below it is rejected with a `422` (`mandate_policy_violation`). This does not dictate the amount debited: the payment session amount remains the source of truth for what is debited. Omit to use the Coinbase-configured default.",
     "examples": [
       "10.00"
     ],
     "type": "string"
   }
 }
}

Fields

max_per_authorization: Option<String>

Max amount for one authorization. Omit to use the Coinbase default. Capped at the Coinbase ceiling.

max_per_period: Option<MandatePolicyPeriodCap>

One rolling cap. Omit to use a Coinbase-configured monthly max. If set, both amount and period are required. Amount is capped at that period’s ceiling.

min_setup_balance: Option<String>

Optional minimum available balance the payer must have to set up the mandate, denominated in the mandate’s asset. When set, the mandate can only be approved if the payer’s available balance is at least this amount; an approval attempted while the balance is below it is rejected with a 422 (mandate_policy_violation). This does not dictate the amount debited: the payment session amount remains the source of truth for what is debited. Omit to use the Coinbase-configured default.

Implementations

impl MandatePolicy

pub fn builder() -> MandatePolicy

Trait Implementations

impl Clone for MandatePolicy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MandatePolicy

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

Formats the value using the given formatter.

impl Default for MandatePolicy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MandatePolicy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&MandatePolicy> for MandatePolicy

fn from(value: &MandatePolicy) -> Self

Converts to this type from the input type.

impl From<MandatePolicy> for MandatePolicy

fn from(value: MandatePolicy) -> Self

Converts to this type from the input type.

impl Serialize for MandatePolicy

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<MandatePolicy> for MandatePolicy

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.