> ## Documentation Index
> Fetch the complete documentation index at: https://docs.methodfi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The card brand endpoint

export const card_brand_details_param = {
  name: 'brands.details',
  type: 'object | null',
  required: false,
  description: <>
      Structured card details for the brand, including APRs, fees, rewards, and promotional offers.
      Available on version <code>2025-07-04</code> and later; <code>null</code> when not available.
      APRs are percentage numbers (<code>19.49</code> = 19.49%); money amounts are integer cents
      (<code>9500</code> = $95.00). Every field is nullable.
    </>,
  items: [{
    name: 'details.card_category',
    type: 'enum | null',
    required: false,
    description: 'Card classification.',
    enums: ['travel', 'cash_back', 'store', 'credit_builder', 'basic', 'dining']
  }, {
    name: 'details.purchase_apr_min',
    type: 'number | null',
    required: false,
    description: 'Low end of the purchase APR range (percent).'
  }, {
    name: 'details.purchase_apr_max',
    type: 'number | null',
    required: false,
    description: 'High end of the purchase APR range (percent).'
  }, {
    name: 'details.cash_advance_apr_min',
    type: 'number | null',
    required: false,
    description: 'Low end of the cash-advance APR range (percent).'
  }, {
    name: 'details.cash_advance_apr_max',
    type: 'number | null',
    required: false,
    description: 'High end of the cash-advance APR range (percent).'
  }, {
    name: 'details.annual_fee',
    type: 'number | null',
    required: false,
    description: 'Ongoing annual fee, in cents.'
  }, {
    name: 'details.late_payment_fee',
    type: 'number | null',
    required: false,
    description: 'Maximum late-payment fee, in cents.'
  }, {
    name: 'details.rewards',
    type: 'object',
    required: false,
    description: 'The rewards program for the brand.',
    items: [{
      name: 'rewards.type',
      type: 'enum | null',
      required: false,
      description: 'Reward currency for the program.',
      enums: ['cash_back', 'points', 'miles', 'discount', 'none']
    }, {
      name: 'rewards.program',
      type: 'string | null',
      required: false,
      description: 'Loyalty / currency program name (e.g. "United MileagePlus").'
    }, {
      name: 'rewards.categories',
      type: 'object[]',
      required: false,
      description: 'Earn categories. The base "all other purchases" rate is included as a category with category "base_rate".',
      items: [{
        name: 'categories.category',
        type: 'enum | null',
        required: false,
        description: 'Normalized earn category.',
        enums: ['travel', 'dining', 'groceries', 'gas', 'streaming', 'store', 'base_rate', 'other']
      }, {
        name: 'categories.category_presentable',
        type: 'string | null',
        required: false,
        description: 'Raw, human-readable label as marketed (e.g. "Dining & restaurants").'
      }, {
        name: 'categories.rate',
        type: 'number | null',
        required: false,
        description: 'Earn multiplier (e.g. 5 = 5x / 5%).'
      }, {
        name: 'categories.unit',
        type: 'enum | null',
        required: false,
        description: 'Earn unit for the rate.',
        enums: ['percent', 'points_per_dollar', 'miles_per_dollar']
      }, {
        name: 'categories.cap',
        type: 'string | null',
        required: false,
        description: 'Free-text spend/earn cap (e.g. "$6,000/year then 1x").'
      }]
    }]
  }, {
    name: 'details.promotions',
    type: 'object[]',
    required: false,
    description: 'Promotional offers. The sign-up bonus is a promotion with type "sign_up_bonus". Empty array when none.',
    items: [{
      name: 'promotions.type',
      type: 'enum | null',
      required: false,
      description: 'Promotion type.',
      enums: ['sign_up_bonus', 'intro_apr', 'partner_promo', 'statement_credit', 'referral_bonus', 'deferred_interest', 'co_brand_promo', 'bonus_rewards', 'other']
    }, {
      name: 'promotions.title',
      type: 'string | null',
      required: false,
      description: 'Short title.'
    }, {
      name: 'promotions.description',
      type: 'string | null',
      required: false,
      description: 'Offer terms.'
    }, {
      name: 'promotions.value',
      type: 'number | null',
      required: false,
      description: 'Numeric value, paired with unit (e.g. 75000 + points; 0 + percent; 25000 + cents).'
    }, {
      name: 'promotions.unit',
      type: 'enum | null',
      required: false,
      description: 'Unit for value.',
      enums: ['points', 'miles', 'percent', 'cents']
    }, {
      name: 'promotions.spend_requirement',
      type: 'number | null',
      required: false,
      description: 'Spend required to earn the offer, in cents.'
    }, {
      name: 'promotions.qualifying_period',
      type: 'object | null',
      required: false,
      description: 'Time window to meet the spend requirement.',
      items: [{
        name: 'qualifying_period.value',
        type: 'integer',
        required: false,
        description: 'Length of the window.'
      }, {
        name: 'qualifying_period.unit',
        type: 'enum',
        required: false,
        description: 'Unit of the window.',
        enums: ['months', 'days']
      }, {
        name: 'qualifying_period.relative_to',
        type: 'enum',
        required: false,
        description: 'What the window is anchored to.',
        enums: ['account_opening']
      }]
    }, {
      name: 'promotions.expiration',
      type: 'string | null',
      required: false,
      description: 'Offer expiration (ISO 8601 date), if time-limited.'
    }]
  }, {
    name: 'details.data_as_of',
    type: 'string | null',
    required: false,
    description: 'ISO 8601 date the card details were last captured.'
  }]
};

export const get_common_parameters = (resource_name = 'resource') => {
  return {
    id: {
      name: 'id',
      type: "string",
      required: false,
      description: `Unique identifier for the ${resource_name}.`
    },
    entity_id: {
      name: 'entity_id',
      type: 'string',
      required: false,
      description: 'The ID of the associated Entity.'
    },
    account_id: {
      name: 'account_id',
      type: 'string',
      required: false,
      description: 'The ID of the associated Account.'
    },
    error: {
      name: 'error',
      type: 'object | null',
      required: false,
      description: <>
          An object representing an error that occurred while processing
          this {resource_name}. See <a href={`/reference/errors/${resource_name.replace(/^([A-Z])/, function (match) {
        return match.toLowerCase();
      }).replace(/([A-Z])/g, function (match) {
        return "-" + match.toLowerCase();
      })}-errors`}>{resource_name} errors</a>.
        </>
    },
    status_error: {
      name: 'status_error',
      type: 'object | null',
      required: false,
      description: <>
          An object representing an error that occurred while processing
          this {resource_name}. See <a href="/reference/errors/product-errors#status-errors">{resource_name} errors</a>.
        </>
    },
    metadata: {
      name: 'metadata',
      type: 'object | null',
      required: false,
      description: <>
          Additional data provided during creation.
          See <a href="/reference/metadata">metadata</a>
        </>
    },
    created_at: {
      name: 'created_at',
      type: 'string',
      required: false,
      description: `Timestamp of when the ${resource_name} was created.`
    },
    updated_at: {
      name: 'updated_at',
      type: 'string',
      required: false,
      description: `Timestamp of when the ${resource_name} was last updated.`
    },
    status: (enums = []) => ({
      name: 'status',
      type: 'enum',
      required: false,
      description: `Status of the ${resource_name}.`,
      enums
    }),
    type: (enums = []) => ({
      name: 'type',
      type: 'enum',
      required: false,
      description: `The type of ${resource_name}.`,
      enums
    })
  };
};

export const ParamList = ({items = [], is_child = false}) => {
  return items.map(item => {
    const field_props = {
      id: Math.random().toString(),
      body: item.name,
      name: item.name,
      type: item.type,
      required: item.required
    };
    const enums = item.enums || [];
    const items = item.items || [];
    const has_items = items?.length > 0;
    const has_enums = enums?.length > 0;
    const should_default_open = item.defaultOpen || false;
    const render_child_item = () => {
      const child_props = {
        title: has_enums ? "Possible enum values" : "properties"
      };
      if (should_default_open) child_props.defaultOpen = true;
      const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
        const is_last = idx === enums.length - 1;
        const is_2nd_to_last = idx === enums.length - 2;
        return <>
            <code>{enum_item}</code>
            {is_last && ''}
            {is_2nd_to_last && ' or '}
            {!is_last && !is_2nd_to_last && ', '}
          </>;
      });
      const enum_list = has_enums && !has_inline_enums && <Accordion {...child_props}>
          {enums.map((enum_item, index) => <div key={`enum-${index}`}>
              <code>{enum_item.name}</code>
              <br />
              <p>{enum_item.description}</p>
            </div>)}
        </Accordion>;
      const item_list = has_items && <Expandable {...child_props}>
          <ParamList items={items || []} is_child />
        </Expandable>;
      return <>
          <p>
            {item.description}
            {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
          </p>

          {enum_list}
          {item_list}
        </>;
    };
    return is_child ? <ResponseField {...field_props}>{render_child_item()}</ResponseField> : <ParamField {...field_props}>{render_child_item()}</ParamField>;
  });
};

The CardBrand endpoint retrieves the associated credit card metadata (Product / Brand Name, Art, etc) directly from the card issuer,
allowing partners to display this information within their wallet experience. On version `2025-07-04` and later, each brand also includes a `details` object with structured card details, including APRs, fees, rewards, and promotional offers.

<Warning>
  The CardBrand endpoint is available only to partners processing payments using the
  <a href="/2025-12-01/reference/accounts/payment-instruments/overview">PaymentInstrument endpoint</a>. Contact your Method CSM for more information.
</Warning>

**The CardBrand endpoint is available as a:**

| Type           | Use-Case                                                                                                      |
| -------------- | ------------------------------------------------------------------------------------------------------------- |
| `Product`      | On-Demand retrieval of credit card metadata (Product / Brand Name, Art, etc) directly from the card issuer    |
| `Subscription` | Near real-time updates on credit card metadata (Product / Brand Name, Art, etc) directly from the card issuer |

## CardBrand Objects

<ParamList
  items={[
(get_common_parameters('CardBrand').id),
(get_common_parameters('CardBrand').account_id),
{
name: 'brands',
type: 'object[]',
required: false,
description: 'The brands associated with the card.',
items: [
  {
    name: 'brands.id',
    type: 'string',
    required: false,
    description: (
      <>
        An ID that uniquely identifies the card's
        brand (ex. <code>pdt_15_brd_1</code> identifies <strong>Chase Sapphire Reserve</strong> with Visa Signature).
      </>
    ),
  },
  {
    name: 'brands.card_product_id',
    type: 'string',
    required: false,
    description: (
      <>
        An ID that uniquely identifies the card's
        associated product (ex. <code>pdt_15</code> identifies <strong>Chase Sapphire Reserve</strong>).
      </>
    ),
  },
  {
    name: 'brands.description',
    type: 'string',
    required: false,
    description: 'The description of the card brand.',
  },
  {
    name: 'brands.name',
    type: 'string',
    required: false,
    description: 'The brand name of the card.',
  },
  {
    name: 'brands.network',
    type: 'string',
    required: false,
    description: "The card's network.",
  },
  {
    name: 'brands.network_tier',
    type: 'string',
    required: false,
    description: "The network tier of the card."
  },
  {
    name: 'brands.type',
    type: 'enum',
    required: false,
    description: 'The type of brand',
    enums: [
      {
        name: 'specific',
        description: 'Indicates that a product has specific metadata that can be directly tied to a specific FI offering. CardBrand executions that are associated with this product will yield an exact Card Image.'
      },
      {
        name: 'generic',
        description: 'Indicates that a product has generic metadata and cannot be tied to a specific FI offering (e.g., standard Capital One card).'
      },
      {
        name: 'in_review',
        description: 'Brands undergoing verification.'
      }
    ],
  },
  {
    name: 'brands.url',
    type: 'string',
    required: false,
    description: 'The URL of the card art.',
  },
  card_brand_details_param,
],
},
{
name: 'source',
type: 'enum | null',
required: false,
description: 'The source of the card brand.',
enums: ['method', 'network', 'null'],
},
{
name: 'status',
type: 'enum',
required: false,
description: 'status of the CardBrand.',
enums: [
  {
    name: 'completed',
    description: 'The CardBrand request successfully completed.',
  },
  {
    name: 'in_progress',
    description: 'The CardBrand request is in progress.',
  },
  {
    name: 'failed',
    description: (<>
        The CardBrand request failed to complete. See{" "}
        <code>error</code> field.
    </>
    )
  },
],
},
(get_common_parameters('CardBrand').error),
(get_common_parameters('CardBrand').created_at),
(get_common_parameters('CardBrand').updated_at),
]}
/>

## Webhook Payload

The [Webhook](/2025-12-01/reference/webhooks/overview) payload will contain the following information:

```json theme={null}
{
  "id": "string",
  "type": "card_brand.create" | "card_brand.update" | "card_brand.available",
  "path": "/accounts/<acc_id>/card_brands/<cbrd_id>",
}
```

<RequestExample>
  ```json THE CARD BRAND OBJECT theme={null}
  {
    "id": "cbrd_Accm7P6t6mYQP",
    "account_id": "acc_LxwEqNicr66yP",
    "brands": [
      {
        "id": "pdt_15_brd_1",
        "card_product_id": "pdt_15",
        "description": "Chase Sapphire Reserve",
        "name": "Chase Sapphire Reserve",
        "issuer": "Chase",
        "network": "visa",
        "network_tier": "infinite",
        "type": "specific",
        "url": "https://static.methodfi.com/card_brands/1b7ccaba6535cb837f802d968add4700.png",
        "details": {
          "card_category": "travel",
          "purchase_apr_min": 21.24,
          "purchase_apr_max": 28.24,
          "cash_advance_apr_min": 29.99,
          "cash_advance_apr_max": 29.99,
          "annual_fee": 55000,
          "late_payment_fee": 4000,
          "rewards": {
            "type": "points",
            "program": "Chase Ultimate Rewards",
            "categories": [
              { "category": "travel", "category_presentable": "Travel booked through Chase Travel", "rate": 5, "unit": "points_per_dollar", "cap": null },
              { "category": "dining", "category_presentable": "Dining", "rate": 3, "unit": "points_per_dollar", "cap": null },
              { "category": "base_rate", "category_presentable": "All other purchases", "rate": 1, "unit": "points_per_dollar", "cap": null }
            ]
          },
          "promotions": [
            {
              "type": "sign_up_bonus",
              "title": "60,000 bonus points",
              "description": "Earn 60,000 bonus points after you spend $4,000 on purchases in the first 3 months from account opening.",
              "value": 60000,
              "unit": "points",
              "spend_requirement": 400000,
              "qualifying_period": { "value": 3, "unit": "months", "relative_to": "account_opening" },
              "expiration": null
            }
          ],
          "data_as_of": "2026-06-03"
        }
      }
    ],
    "status": "completed",
    "source": "method",
    "error": null,
    "created_at": "2025-08-12T00:56:50.139Z",
    "updated_at": "2025-08-12T00:56:50.139Z"
  }
  ```
</RequestExample>