Skip to content

CustomerBankAccount

Type: schema

TypeScript Definition

typescript
CustomerBankAccount: {{
            /** @enum {unknown} */
            account_type: "inbound" | "outbound";
            account_name: string;
            account_number: string;
            ifsc_code: string;
            bank_name: string;
            /** @description default bank account for the customer. */
            is_default?: boolean;
            is_verified?: $Read<boolean>;
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
        };
        /** CustomerCreditLineBalance */
}

OpenAPI Schema

json
{
  "title": "CustomerBankAccount",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerBankAccount",
    "description": "API reference for the CustomerBankAccount schema"
  },
  "required": [
    "account_type",
    "account_name",
    "account_number",
    "ifsc_code",
    "bank_name"
  ],
  "properties": {
    "account_type": {
      "enum": [
        "inbound",
        "outbound"
      ]
    },
    "account_name": {
      "type": "string"
    },
    "account_number": {
      "type": "string"
    },
    "ifsc_code": {
      "type": "string"
    },
    "bank_name": {
      "type": "string"
    },
    "is_default": {
      "description": "default bank account for the customer.",
      "type": "boolean"
    },
    "is_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: