Skip to content

CustomerMandateState ​

Type: schema

Description ​

A customer's NACH e-mandate: their standing authorization to debit their bank account for orders on credit.

TypeScript Definition ​

typescript
CustomerMandateState: {{
            id: string;
            /** @description The mandate's type at the payment gateway. */
            mandate_type: string;
            /**
             * @description The mandate's status after the change; `changes.status` holds the move.
             * @enum {string}
             */
            status: "created" | "active" | "paused" | "pause_requested" | "revoked" | "revoke_requested" | "error" | "expired";
            /** @description The most one debit may take: the credit line's `mandate_per_order_limit` when the mandate was created. */
            max_amount: number;
            /** @description When the bank may debit; `ASPRESENTED` means as each debit is presented. */
            frequency: string;
            /**
             * Format: date-time
             * @description Start of the mandate's validity: when it was created.
             */
            start_date: string;
            /**
             * Format: date-time
             * @description End of the mandate's validity: 365 days after creation.
             */
            end_date: string;
            /** @description The payment gateway that holds the mandate. */
            gateway: string;
            /** @description The mandate's reference at the payment gateway. */
            gateway_reference_id: string;
            store_id: string;
        };
        /** CustomerSegment */
}

OpenAPI Schema ​

json
{
  "title": "CustomerMandateState",
  "description": "A customer's NACH e-mandate: their standing authorization to debit their bank account for orders on credit.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerMandateState",
    "description": "API reference for the CustomerMandateState schema"
  },
  "required": [
    "end_date",
    "frequency",
    "gateway",
    "gateway_reference_id",
    "id",
    "mandate_type",
    "max_amount",
    "start_date",
    "status",
    "store_id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "mandate_type": {
      "description": "The mandate's type at the payment gateway.",
      "type": "string"
    },
    "status": {
      "description": "The mandate's status after the change; `changes.status` holds the move.",
      "type": "string",
      "enum": [
        "created",
        "active",
        "paused",
        "pause_requested",
        "revoked",
        "revoke_requested",
        "error",
        "expired"
      ]
    },
    "max_amount": {
      "description": "The most one debit may take: the credit line's `mandate_per_order_limit` when the mandate was created.",
      "type": "number"
    },
    "frequency": {
      "description": "When the bank may debit; `ASPRESENTED` means as each debit is presented.",
      "type": "string"
    },
    "start_date": {
      "description": "Start of the mandate's validity: when it was created.",
      "type": "string",
      "format": "date-time"
    },
    "end_date": {
      "description": "End of the mandate's validity: 365 days after creation.",
      "type": "string",
      "format": "date-time"
    },
    "gateway": {
      "description": "The payment gateway that holds the mandate.",
      "type": "string"
    },
    "gateway_reference_id": {
      "description": "The mandate's reference at the payment gateway.",
      "type": "string"
    },
    "store_id": {
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: