Skip to content

SellerBankAccount ​

Type: schema

Description ​

A marketplace seller's payout bank account. account_number is masked to its last 4 digits.

TypeScript Definition ​

typescript
SellerBankAccount: {{
            id: string;
            account_type: string;
            account_name: string;
            account_number: string;
            ifsc_code: string;
            bank_name: string;
            /** @description The account passed penny-drop verification when it was added. */
            is_verified: boolean;
            /** @description The seller's payouts are settled to this account. A seller has one default account. */
            is_default: boolean;
        };
        /**
         * SellerBusinessType
         * @enum {string}
         */
}

OpenAPI Schema ​

json
{
  "title": "SellerBankAccount",
  "description": "A marketplace seller's payout bank account. `account_number` is masked to its last 4 digits.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/SellerBankAccount",
    "description": "API reference for the SellerBankAccount schema"
  },
  "required": [
    "id",
    "account_type",
    "account_name",
    "account_number",
    "ifsc_code",
    "bank_name",
    "is_verified",
    "is_default"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "account_type": {
      "type": "string"
    },
    "account_name": {
      "type": "string"
    },
    "account_number": {
      "type": "string"
    },
    "ifsc_code": {
      "type": "string"
    },
    "bank_name": {
      "type": "string"
    },
    "is_verified": {
      "description": "The account passed penny-drop verification when it was added.",
      "type": "boolean"
    },
    "is_default": {
      "description": "The seller's payouts are settled to this account. A seller has one default account.",
      "type": "boolean"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: