CustomerMandate

Type: schema

TypeScript Definition

CustomerMandate: {{
            id: string;
            mandate_type?: string;
            status: components["schemas"]["MandateStatus"];
            max_amount?: number;
            frequency?: string;
            /** Format: date-time */
            start_date?: string;
            /** Format: date-time */
            end_date?: string;
            gateway?: string;
            gateway_reference_id?: string;
            block_fund?: boolean;
            revokable_by_customer?: boolean;
            currency?: string;
            payment_info?: {
                payment_method_type?: string;
                payment_method?: string;
                bank_details?: {
                    account_number?: string;
                    ifsc?: string;
                    bank_account_type?: string;
                    beneficiary_name?: string;
                    bank_name?: string;
                };
            };
            /** Format: date-time */
            created_at?: string;
            /** Format: date-time */
            modified_at?: string;
            /** Format: date-time */
            activated_at?: string;
            /** Format: date-time */
            last_activated_at?: string;
        };
        /**
         * CustomerReadyForReview
         * @description List of products and orders for which customer can write review.
         */
}

Component References

Reference	Resolves To
components["schemas"]["MandateStatus"]	MandateStatus

OpenAPI Schema

{
  "title": "CustomerMandate",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerMandate",
    "description": "API reference for the CustomerMandate schema"
  },
  "required": [
    "id",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "mandate_type": {
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/MandateStatus"
    },
    "max_amount": {
      "type": "integer"
    },
    "frequency": {
      "type": "string"
    },
    "start_date": {
      "type": "string",
      "format": "date-time"
    },
    "end_date": {
      "type": "string",
      "format": "date-time"
    },
    "gateway": {
      "type": "string"
    },
    "gateway_reference_id": {
      "type": "string"
    },
    "block_fund": {
      "type": "boolean"
    },
    "revokable_by_customer": {
      "type": "boolean"
    },
    "currency": {
      "type": "string"
    },
    "payment_info": {
      "type": "object",
      "properties": {
        "payment_method_type": {
          "type": "string"
        },
        "payment_method": {
          "type": "string"
        },
        "bank_details": {
          "type": "object",
          "properties": {
            "account_number": {
              "type": "string"
            },
            "ifsc": {
              "type": "string"
            },
            "bank_account_type": {
              "type": "string"
            },
            "beneficiary_name": {
              "type": "string"
            },
            "bank_name": {
              "type": "string"
            }
          }
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    },
    "activated_at": {
      "type": "string",
      "format": "date-time"
    },
    "last_activated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions