Moon Banking Logo

Bank Products

A bank product is something a bank offers to its customers, such as an account, a card, a loan, or a service. Products are supplied and maintained by verified representatives of the bank, and appear on the bank's Moon Banking page.

The bankProduct model

The bank product model contains the products and services a bank offers, including their rates, fees, and terms.

Properties

    Name
    id
    Type
    string
    Description

    The product's auto-generated unique identifier.

    Name
    bankId
    Type
    string
    Description

    The ID of the bank that offers this product.

    Name
    category
    Type
    enum
    Description

    The broad category the product belongs to. Drives how the product is grouped on the bank's page.

    Possible values: ACCOUNT, CARD, LOAN, INVESTMENT, INSURANCE, SERVICE, OTHER

    Name
    type
    Type
    enum
    Description

    The specific kind of product.

    Possible values: CHECKING_ACCOUNT, SAVINGS_ACCOUNT, MONEY_MARKET_ACCOUNT, CERTIFICATE_OF_DEPOSIT, BUSINESS_CHECKING_ACCOUNT, BUSINESS_SAVINGS_ACCOUNT, YOUTH_ACCOUNT, CREDIT_CARD, DEBIT_CARD, BUSINESS_CREDIT_CARD, SECURED_CREDIT_CARD, PREPAID_CARD, PERSONAL_LOAN, AUTO_LOAN, MORTGAGE, HOME_EQUITY_LOAN, HOME_EQUITY_LINE_OF_CREDIT, STUDENT_LOAN, BUSINESS_LOAN, LINE_OF_CREDIT, CONSTRUCTION_LOAN, BROKERAGE_ACCOUNT, RETIREMENT_ACCOUNT, WEALTH_MANAGEMENT, INSURANCE, WIRE_TRANSFER, FOREIGN_EXCHANGE, MERCHANT_SERVICES, TREASURY_MANAGEMENT, SAFE_DEPOSIT_BOX, ONLINE_BANKING, MOBILE_BANKING, CRYPTO_SERVICE, OTHER

    Name
    name
    Type
    string
    Constraints
    min2•max160
    Description

    The product's marketing name.

    Name
    summary
    Type
    string
    Description

    A one or two sentence summary of the product.

    Name
    details
    Type
    string
    Description

    The full product details in Markdown (md) format.

    Name
    url
    Type
    string
    Description

    A link to the product page on the bank's own website.

    Name
    currency
    Type
    string
    Description

    The ISO 4217 currency code for every monetary amount on this product.

    Name
    status
    Type
    enum
    Description

    Whether the product is a draft, published to the bank's page, or archived.

    Possible values: DRAFT, PUBLISHED, ARCHIVED

    Name
    rateType
    Type
    string
    Description

    How the rate on this product should be read.

    Name
    ratePercent
    Type
    number
    Description

    The product's headline rate as a percentage. Use this for a single advertised rate.

    Name
    rateMinPercent
    Type
    number
    Description

    The low end of the rate range, as a percentage. Use this with rateMaxPercent when the rate depends on the customer.

    Name
    rateMaxPercent
    Type
    number
    Description

    The high end of the rate range, as a percentage.

    Name
    rateNote
    Type
    string
    Description

    A short qualifier on the rate, such as what it depends on or when it changes.

    Name
    monthlyFeeCents
    Type
    integer
    Description

    The recurring monthly fee, in the smallest unit of the product's currency.

    Name
    annualFeeCents
    Type
    integer
    Description

    The recurring annual fee, in the smallest unit of the product's currency.

    Name
    minimumOpeningDepositCents
    Type
    integer
    Description

    The deposit required to open the product, in the smallest unit of the product's currency.

    Name
    minimumBalanceCents
    Type
    integer
    Description

    The balance the customer has to keep to avoid fees or keep the rate, in the smallest unit of the product's currency.

    Name
    termMonths
    Type
    integer
    Description

    The product's term in months, for products with a fixed term such as CDs and loans.

    Name
    termNote
    Type
    string
    Description

    A short qualifier on the term.

    Name
    features
    Type
    array
    Description
    Name
    attributes
    Type
    array
    Description

    Additional labelled values that don’t map onto the product’s standard fields.

    Name
    effectiveDate
    Type
    string
    Description
    Name
    displayOrder
    Type
    integer
    Description

    Sort position within the product's category. Lower values are shown first.

    Name
    createdAt
    Type
    string
    Description

    The date and time the product was created.

    Name
    updatedAt
    Type
    string
    Description

    The date and time the product was last updated.

    Name
    bankName
    Type
    string
    Description

    The name of the bank that offers this product.

GET/bank-products

GET /bank-products

This endpoint allows you to retrieve a paginated list of published bank products across all banks, so you can compare rates and terms between institutions. Filter by bank, country, category, type, currency, and rate, and sort by rate to find the most competitive offers. Products are supplied and maintained by each bank's own verified representatives. Every product includes the name of the bank that offers it.

Optional parameters

    Name
    limit
    Type
    integer
    Constraints
    min1•max100
    Default
    default10
    Description

    Number of items to return.

    Name
    starting_after
    Type
    string
    Description

    Cursor for forward pagination. Use the id of the last item from the previous page to get the next page.

    Name
    ending_before
    Type
    string
    Description

    Cursor for backward pagination. Use the id of the first item from the current page to get the previous page.

    Name
    bankId
    Type
    string
    Description

    Filter by the id of the bank that offers the product.

    Name
    countryCode
    Type
    string
    Constraints
    min2•max2
    Description

    Filter by the ISO country code of the bank offering the product.

    Name
    categories
    Type
    string
    Description

    An optional comma-separated list of fields to include in the response. Possible values: ACCOUNT, CARD, LOAN, INVESTMENT, INSURANCE, SERVICE, OTHER

    Name
    types
    Type
    string
    Description

    An optional comma-separated list of fields to include in the response. Possible values: CHECKING_ACCOUNT, SAVINGS_ACCOUNT, MONEY_MARKET_ACCOUNT, CERTIFICATE_OF_DEPOSIT, BUSINESS_CHECKING_ACCOUNT, BUSINESS_SAVINGS_ACCOUNT, YOUTH_ACCOUNT, CREDIT_CARD, DEBIT_CARD, BUSINESS_CREDIT_CARD, SECURED_CREDIT_CARD, PREPAID_CARD, PERSONAL_LOAN, AUTO_LOAN, MORTGAGE, HOME_EQUITY_LOAN, HOME_EQUITY_LINE_OF_CREDIT, STUDENT_LOAN, BUSINESS_LOAN, LINE_OF_CREDIT, CONSTRUCTION_LOAN, BROKERAGE_ACCOUNT, RETIREMENT_ACCOUNT, WEALTH_MANAGEMENT, INSURANCE, WIRE_TRANSFER, FOREIGN_EXCHANGE, MERCHANT_SERVICES, TREASURY_MANAGEMENT, SAFE_DEPOSIT_BOX, ONLINE_BANKING, MOBILE_BANKING, CRYPTO_SERVICE, OTHER

    Name
    currency
    Type
    string
    Constraints
    min3•max3
    Description

    Filter by the ISO 4217 currency code the product is denominated in.

    Name
    search
    Type
    string
    Description

    Search products by name.

    Name
    minRatePercent
    Type
    number
    Constraints
    min0•max1000
    Description

    Only return products whose rate reaches at least this percentage. A product matches on either its headline rate or the top of its rate range.

    Name
    maxRatePercent
    Type
    number
    Constraints
    min0•max1000
    Description

    Only return products whose rate is no higher than this percentage. A product matches on either its headline rate or the bottom of its rate range.

    Name
    sortBy
    Type
    enum
    Default
    default"ratePercent"
    Description

    Field to sort by. Products that leave the sorted field empty are always returned last.

    Possible values: ratePercent, name, effectiveDate, createdAt, updatedAt

    Name
    sortOrder
    Type
    enum
    Default
    default"desc"
    Description

    Sort order. Either ascending or descending.

    Possible values: asc, desc

Request

GET
/bank-products
curl -G https://api.moonbanking.com/v1/bank-products \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Moon-Banking-Version: 2025-07-11" \
  --data-urlencode "limit=20" \
  --data-urlencode "starting_after=8HsY5nBc7jAqM4u" \
  --data-urlencode "ending_before=6jkxE4N8gHXgDPK" \
  --data-urlencode "bankId=6jkxE4N8gHXgDPK" \
  --data-urlencode "countryCode=US" \
  --data-urlencode "categories=ACCOUNT%2CCARD%2CLOAN%2CINVESTMENT%2CINSURANCE%2CSERVICE%2COTHER" \
  --data-urlencode "types=CHECKING_ACCOUNT%2CSAVINGS_ACCOUNT%2CMONEY_MARKET_ACCOUNT%2CCERTIFICATE_OF_DEPOSIT%2CBUSINESS_CHECKING_ACCOUNT%2CBUSINESS_SAVINGS_ACCOUNT%2CYOUTH_ACCOUNT%2CCREDIT_CARD%2CDEBIT_CARD%2CBUSINESS_CREDIT_CARD%2CSECURED_CREDIT_CARD%2CPREPAID_CARD%2CPERSONAL_LOAN%2CAUTO_LOAN%2CMORTGAGE%2CHOME_EQUITY_LOAN%2CHOME_EQUITY_LINE_OF_CREDIT%2CSTUDENT_LOAN%2CBUSINESS_LOAN%2CLINE_OF_CREDIT%2CCONSTRUCTION_LOAN%2CBROKERAGE_ACCOUNT%2CRETIREMENT_ACCOUNT%2CWEALTH_MANAGEMENT%2CINSURANCE%2CWIRE_TRANSFER%2CFOREIGN_EXCHANGE%2CMERCHANT_SERVICES%2CTREASURY_MANAGEMENT%2CSAFE_DEPOSIT_BOX%2CONLINE_BANKING%2CMOBILE_BANKING%2CCRYPTO_SERVICE%2COTHER" \
  --data-urlencode "currency=USD" \
  --data-urlencode "search=savings" \
  --data-urlencode "minRatePercent=4" \
  --data-urlencode "maxRatePercent=8" \
  --data-urlencode "sortBy=ratePercent" \
  --data-urlencode "sortOrder=desc"

Response

{
  "success": true,
  "data": [
    {
      "id": "8HsY5nBc7jAqM4u",
      "bankId": "6jkxE4N8gHXgDPK",
      "category": "ACCOUNT",
      "type": "CHECKING_ACCOUNT",
      "name": "High-Yield Savings",
      "summary": "A savings account with no monthly fee and a competitive yield.",
      "details": "## Eligibility\n\nAvailable to US residents aged 18 and over.",
      "url": "https://www.fidelity.com/savings",
      "currency": "USD",
      "status": "DRAFT",
      "rateType": "APY",
      "ratePercent": 4.25,
      "rateMinPercent": 6.99,
      "rateMaxPercent": 21.99,
      "rateNote": "Rate depends on credit score and term.",
      "monthlyFeeCents": 0,
      "annualFeeCents": 9500,
      "minimumOpeningDepositCents": 2500,
      "minimumBalanceCents": 150000,
      "termMonths": 60,
      "termNote": "Terms from 12 to 84 months are available.",
      "features": [
        "No monthly maintenance fee",
        "FDIC insured up to $250,000"
      ],
      "attributes": [
        {
          "label": "Foreign transaction fee",
          "value": "None"
        },
    ...
  ],
      "effectiveDate": "sample_effectiveDate",
      "displayOrder": 0,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "bankName": "Fidelity"
    },
    ...
  ],
  "pagination": {
    "hasMore": true,
    "limit": 20,
    "nextCursor": "8HsY5nBc7jAqM4u",
    "previousCursor": "6jkxE4N8gHXgDPK",
    "meta": {
      "total": 42
    }
  },
  "message": "Sample message",
  "timestamp": "2026-04-09T00:39:30.636Z",
  "version": "2025-07-11"
}
GET/banks/:bankId/products

GET /banks/:bankId/products

This endpoint allows you to retrieve the products and services a bank publishes on its Moon Banking profile, such as deposit accounts, loans, and credit cards. Products are supplied and maintained by the bank's own verified representatives. Only published products are returned; drafts, archived entries, and anything removed by the Moon Banking team are excluded.

Required parameters

    Name
    bankId
    Type
    string
    Description

    The bank's auto-generated unique identifier.

Request

GET
/banks/:bankId/products
curl -G https://api.moonbanking.com/v1/banks/6jkxE4N8gHXgDPK/products \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Moon-Banking-Version: 2025-07-11"

Response

{
  "success": true,
  "data": [
    {
      "id": "8HsY5nBc7jAqM4u",
      "bankId": "6jkxE4N8gHXgDPK",
      "category": "ACCOUNT",
      "type": "CHECKING_ACCOUNT",
      "name": "High-Yield Savings",
      "summary": "A savings account with no monthly fee and a competitive yield.",
      "details": "## Eligibility\n\nAvailable to US residents aged 18 and over.",
      "url": "https://www.fidelity.com/savings",
      "currency": "USD",
      "status": "DRAFT",
      "rateType": "APY",
      "ratePercent": 4.25,
      "rateMinPercent": 6.99,
      "rateMaxPercent": 21.99,
      "rateNote": "Rate depends on credit score and term.",
      "monthlyFeeCents": 0,
      "annualFeeCents": 9500,
      "minimumOpeningDepositCents": 2500,
      "minimumBalanceCents": 150000,
      "termMonths": 60,
      "termNote": "Terms from 12 to 84 months are available.",
      "features": [
        "No monthly maintenance fee",
        "FDIC insured up to $250,000"
      ],
      "attributes": [
        {
          "label": "Foreign transaction fee",
          "value": "None"
        },
    ...
  ],
      "effectiveDate": "sample_effectiveDate",
      "displayOrder": 0,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "bankName": "Fidelity"
    },
    ...
  ],
  "message": "Sample message",
  "timestamp": "2026-04-09T00:39:30.636Z",
  "version": "2025-07-11"
}
POST/banks/:bankId/products

POST /banks/:bankId/products

This endpoint allows a bank's verified representatives to add a product to the bank's profile. Products default to published and appear on the bank's public page immediately. Pass status as DRAFT to stage a product without publishing it. You must be an approved representative of the bank.

Required parameters

    Name
    bankId
    Type
    string
    Description

    The bank's auto-generated unique identifier.

Required attributes

    Name
    category
    Type
    enum
    Description

    The broad category the product belongs to. Drives how the product is grouped on the bank's page.

    Possible values: ACCOUNT, CARD, LOAN, INVESTMENT, INSURANCE, SERVICE, OTHER

    Name
    type
    Type
    enum
    Description

    The specific kind of product.

    Possible values: CHECKING_ACCOUNT, SAVINGS_ACCOUNT, MONEY_MARKET_ACCOUNT, CERTIFICATE_OF_DEPOSIT, BUSINESS_CHECKING_ACCOUNT, BUSINESS_SAVINGS_ACCOUNT, YOUTH_ACCOUNT, CREDIT_CARD, DEBIT_CARD, BUSINESS_CREDIT_CARD, SECURED_CREDIT_CARD, PREPAID_CARD, PERSONAL_LOAN, AUTO_LOAN, MORTGAGE, HOME_EQUITY_LOAN, HOME_EQUITY_LINE_OF_CREDIT, STUDENT_LOAN, BUSINESS_LOAN, LINE_OF_CREDIT, CONSTRUCTION_LOAN, BROKERAGE_ACCOUNT, RETIREMENT_ACCOUNT, WEALTH_MANAGEMENT, INSURANCE, WIRE_TRANSFER, FOREIGN_EXCHANGE, MERCHANT_SERVICES, TREASURY_MANAGEMENT, SAFE_DEPOSIT_BOX, ONLINE_BANKING, MOBILE_BANKING, CRYPTO_SERVICE, OTHER

    Name
    name
    Type
    string
    Constraints
    min2•max160
    Description

    The product's marketing name.

Optional attributes

    Name
    summary
    Type
    string
    Description
    Name
    details
    Type
    string
    Description
    Name
    url
    Type
    string
    Description
    Name
    currency
    Type
    string
    Description
    Name
    status
    Type
    enum
    Description

    Whether the product is a draft, published to the bank's page, or archived.

    Possible values: DRAFT, PUBLISHED, ARCHIVED

    Name
    rateType
    Type
    string
    Description

    How the rate on this product should be read.

    Name
    ratePercent
    Type
    number
    Description
    Name
    rateMinPercent
    Type
    number
    Description
    Name
    rateMaxPercent
    Type
    number
    Description
    Name
    rateNote
    Type
    string
    Description
    Name
    monthlyFeeCents
    Type
    integer
    Description
    Name
    annualFeeCents
    Type
    integer
    Description
    Name
    minimumOpeningDepositCents
    Type
    integer
    Description
    Name
    minimumBalanceCents
    Type
    integer
    Description
    Name
    termMonths
    Type
    integer
    Description
    Name
    termNote
    Type
    string
    Description
    Name
    features
    Type
    array
    Description
    Name
    attributes
    Type
    array
    Description
    Name
    effectiveDate
    Type
    string
    Description
    Name
    displayOrder
    Type
    integer
    Constraints
    min0•max999
    Description

Request

POST
/banks/:bankId/products
curl -X POST https://api.moonbanking.com/v1/banks/6jkxE4N8gHXgDPK/products \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Moon-Banking-Version: 2025-07-11" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "ACCOUNT",
  "type": "SAVINGS_ACCOUNT",
  "name": "High-Yield Savings"
  }'

Response

{
  "success": true,
  "data": {
    "id": "8HsY5nBc7jAqM4u",
    "bankId": "6jkxE4N8gHXgDPK",
    "category": "ACCOUNT",
    "type": "CHECKING_ACCOUNT",
    "name": "High-Yield Savings",
    "summary": "A savings account with no monthly fee and a competitive yield.",
    "details": "## Eligibility\n\nAvailable to US residents aged 18 and over.",
    "url": "https://www.fidelity.com/savings",
    "currency": "USD",
    "status": "DRAFT",
    "rateType": "APY",
    "ratePercent": 4.25,
    "rateMinPercent": 6.99,
    "rateMaxPercent": 21.99,
    "rateNote": "Rate depends on credit score and term.",
    "monthlyFeeCents": 0,
    "annualFeeCents": 9500,
    "minimumOpeningDepositCents": 2500,
    "minimumBalanceCents": 150000,
    "termMonths": 60,
    "termNote": "Terms from 12 to 84 months are available.",
    "features": [
      "No monthly maintenance fee",
      "FDIC insured up to $250,000"
    ],
    "attributes": [
      {
        "label": "Foreign transaction fee",
        "value": "None"
      },
    ...
  ],
    "effectiveDate": "sample_effectiveDate",
    "displayOrder": 0,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "bankName": "Fidelity"
  },
  "message": "Sample message",
  "timestamp": "2026-04-09T00:39:30.636Z",
  "version": "2025-07-11"
}
GET/banks/:bankId/managed-products

GET /banks/:bankId/managed-products

This endpoint allows a bank's verified representatives to retrieve every product on the bank's profile, including drafts and archived entries that the public list omits. Use it to reconcile your own catalog against Moon Banking before syncing changes. You must be an approved representative of the bank.

Required parameters

    Name
    bankId
    Type
    string
    Description

    The bank's auto-generated unique identifier.

Request

GET
/banks/:bankId/managed-products
curl -G https://api.moonbanking.com/v1/banks/6jkxE4N8gHXgDPK/managed-products \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Moon-Banking-Version: 2025-07-11"

Response

{
  "success": true,
  "data": [
    {
      "id": "8HsY5nBc7jAqM4u",
      "bankId": "6jkxE4N8gHXgDPK",
      "category": "ACCOUNT",
      "type": "CHECKING_ACCOUNT",
      "name": "High-Yield Savings",
      "summary": "A savings account with no monthly fee and a competitive yield.",
      "details": "## Eligibility\n\nAvailable to US residents aged 18 and over.",
      "url": "https://www.fidelity.com/savings",
      "currency": "USD",
      "status": "DRAFT",
      "rateType": "APY",
      "ratePercent": 4.25,
      "rateMinPercent": 6.99,
      "rateMaxPercent": 21.99,
      "rateNote": "Rate depends on credit score and term.",
      "monthlyFeeCents": 0,
      "annualFeeCents": 9500,
      "minimumOpeningDepositCents": 2500,
      "minimumBalanceCents": 150000,
      "termMonths": 60,
      "termNote": "Terms from 12 to 84 months are available.",
      "features": [
        "No monthly maintenance fee",
        "FDIC insured up to $250,000"
      ],
      "attributes": [
        {
          "label": "Foreign transaction fee",
          "value": "None"
        },
    ...
  ],
      "effectiveDate": "sample_effectiveDate",
      "displayOrder": 0,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "bankName": "Fidelity"
    },
    ...
  ],
  "message": "Sample message",
  "timestamp": "2026-04-09T00:39:30.636Z",
  "version": "2025-07-11"
}
PUT/banks/:bankId/products/:id

PUT /banks/:bankId/products/:id

This endpoint allows a bank's verified representatives to replace a product's details. Every writable field is overwritten, so send the product's full state rather than only the fields that changed. This is the endpoint to call when rates or fees move. You must be an approved representative of the bank.

Required parameters

    Name
    bankId
    Type
    string
    Description

    The bank's auto-generated unique identifier.

    Name
    id
    Type
    string
    Description

    The product's auto-generated unique identifier.

Required attributes

    Name
    category
    Type
    enum
    Description

    The broad category the product belongs to. Drives how the product is grouped on the bank's page.

    Possible values: ACCOUNT, CARD, LOAN, INVESTMENT, INSURANCE, SERVICE, OTHER

    Name
    type
    Type
    enum
    Description

    The specific kind of product.

    Possible values: CHECKING_ACCOUNT, SAVINGS_ACCOUNT, MONEY_MARKET_ACCOUNT, CERTIFICATE_OF_DEPOSIT, BUSINESS_CHECKING_ACCOUNT, BUSINESS_SAVINGS_ACCOUNT, YOUTH_ACCOUNT, CREDIT_CARD, DEBIT_CARD, BUSINESS_CREDIT_CARD, SECURED_CREDIT_CARD, PREPAID_CARD, PERSONAL_LOAN, AUTO_LOAN, MORTGAGE, HOME_EQUITY_LOAN, HOME_EQUITY_LINE_OF_CREDIT, STUDENT_LOAN, BUSINESS_LOAN, LINE_OF_CREDIT, CONSTRUCTION_LOAN, BROKERAGE_ACCOUNT, RETIREMENT_ACCOUNT, WEALTH_MANAGEMENT, INSURANCE, WIRE_TRANSFER, FOREIGN_EXCHANGE, MERCHANT_SERVICES, TREASURY_MANAGEMENT, SAFE_DEPOSIT_BOX, ONLINE_BANKING, MOBILE_BANKING, CRYPTO_SERVICE, OTHER

    Name
    name
    Type
    string
    Constraints
    min2•max160
    Description

    The product's marketing name.

Optional attributes

    Name
    summary
    Type
    string
    Description
    Name
    details
    Type
    string
    Description
    Name
    url
    Type
    string
    Description
    Name
    currency
    Type
    string
    Description
    Name
    status
    Type
    enum
    Description

    Whether the product is a draft, published to the bank's page, or archived.

    Possible values: DRAFT, PUBLISHED, ARCHIVED

    Name
    rateType
    Type
    string
    Description

    How the rate on this product should be read.

    Name
    ratePercent
    Type
    number
    Description
    Name
    rateMinPercent
    Type
    number
    Description
    Name
    rateMaxPercent
    Type
    number
    Description
    Name
    rateNote
    Type
    string
    Description
    Name
    monthlyFeeCents
    Type
    integer
    Description
    Name
    annualFeeCents
    Type
    integer
    Description
    Name
    minimumOpeningDepositCents
    Type
    integer
    Description
    Name
    minimumBalanceCents
    Type
    integer
    Description
    Name
    termMonths
    Type
    integer
    Description
    Name
    termNote
    Type
    string
    Description
    Name
    features
    Type
    array
    Description
    Name
    attributes
    Type
    array
    Description
    Name
    effectiveDate
    Type
    string
    Description
    Name
    displayOrder
    Type
    integer
    Constraints
    min0•max999
    Description

Request

PUT
/banks/:bankId/products/:id
curl -X PUT https://api.moonbanking.com/v1/banks/6jkxE4N8gHXgDPK/products/8HsY5nBc7jAqM4u \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Moon-Banking-Version: 2025-07-11" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "ACCOUNT",
  "type": "SAVINGS_ACCOUNT",
  "name": "High-Yield Savings"
  }'

Response

{
  "success": true,
  "data": {
    "id": "8HsY5nBc7jAqM4u",
    "bankId": "6jkxE4N8gHXgDPK",
    "category": "ACCOUNT",
    "type": "CHECKING_ACCOUNT",
    "name": "High-Yield Savings",
    "summary": "A savings account with no monthly fee and a competitive yield.",
    "details": "## Eligibility\n\nAvailable to US residents aged 18 and over.",
    "url": "https://www.fidelity.com/savings",
    "currency": "USD",
    "status": "DRAFT",
    "rateType": "APY",
    "ratePercent": 4.25,
    "rateMinPercent": 6.99,
    "rateMaxPercent": 21.99,
    "rateNote": "Rate depends on credit score and term.",
    "monthlyFeeCents": 0,
    "annualFeeCents": 9500,
    "minimumOpeningDepositCents": 2500,
    "minimumBalanceCents": 150000,
    "termMonths": 60,
    "termNote": "Terms from 12 to 84 months are available.",
    "features": [
      "No monthly maintenance fee",
      "FDIC insured up to $250,000"
    ],
    "attributes": [
      {
        "label": "Foreign transaction fee",
        "value": "None"
      },
    ...
  ],
    "effectiveDate": "sample_effectiveDate",
    "displayOrder": 0,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "bankName": "Fidelity"
  },
  "message": "Sample message",
  "timestamp": "2026-04-09T00:39:30.636Z",
  "version": "2025-07-11"
}
DELETE/banks/:bankId/products/:id

DELETE /banks/:bankId/products/:id

This endpoint allows a bank's verified representatives to permanently remove a product from the bank's profile. This cannot be undone. To retire a product while keeping its record, set its status to ARCHIVED instead. You must be an approved representative of the bank.

Required parameters

    Name
    bankId
    Type
    string
    Description

    The bank's auto-generated unique identifier.

    Name
    id
    Type
    string
    Description

    The product's auto-generated unique identifier.

Request

DELETE
/banks/:bankId/products/:id
curl -X DELETE https://api.moonbanking.com/v1/banks/6jkxE4N8gHXgDPK/products/8HsY5nBc7jAqM4u \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Moon-Banking-Version: 2025-07-11"

Response

{
  "success": true,
  "data": {
    "id": "8HsY5nBc7jAqM4u"
  },
  "message": "Sample message",
  "timestamp": "2026-04-09T00:39:30.636Z",
  "version": "2025-07-11"
}
PUT/banks/:bankId/products/:id/status

PUT /banks/:bankId/products/:id/status

This endpoint allows a bank's verified representatives to move a product between draft, published, and archived without resubmitting its details. Archiving is the reversible way to retire a product you may bring back; deleting is permanent. You must be an approved representative of the bank.

Required parameters

    Name
    bankId
    Type
    string
    Description

    The bank's auto-generated unique identifier.

    Name
    id
    Type
    string
    Description

    The product's auto-generated unique identifier.

Required attributes

    Name
    status
    Type
    enum
    Description

    Whether the product is a draft, published to the bank's page, or archived.

    Possible values: DRAFT, PUBLISHED, ARCHIVED

Request

PUT
/banks/:bankId/products/:id/status
curl -X PUT https://api.moonbanking.com/v1/banks/6jkxE4N8gHXgDPK/products/8HsY5nBc7jAqM4u/status \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Moon-Banking-Version: 2025-07-11" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "PUBLISHED"
  }'

Response

{
  "success": true,
  "data": {
    "id": "8HsY5nBc7jAqM4u",
    "bankId": "6jkxE4N8gHXgDPK",
    "category": "ACCOUNT",
    "type": "CHECKING_ACCOUNT",
    "name": "High-Yield Savings",
    "summary": "A savings account with no monthly fee and a competitive yield.",
    "details": "## Eligibility\n\nAvailable to US residents aged 18 and over.",
    "url": "https://www.fidelity.com/savings",
    "currency": "USD",
    "status": "DRAFT",
    "rateType": "APY",
    "ratePercent": 4.25,
    "rateMinPercent": 6.99,
    "rateMaxPercent": 21.99,
    "rateNote": "Rate depends on credit score and term.",
    "monthlyFeeCents": 0,
    "annualFeeCents": 9500,
    "minimumOpeningDepositCents": 2500,
    "minimumBalanceCents": 150000,
    "termMonths": 60,
    "termNote": "Terms from 12 to 84 months are available.",
    "features": [
      "No monthly maintenance fee",
      "FDIC insured up to $250,000"
    ],
    "attributes": [
      {
        "label": "Foreign transaction fee",
        "value": "None"
      },
    ...
  ],
    "effectiveDate": "sample_effectiveDate",
    "displayOrder": 0,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "bankName": "Fidelity"
  },
  "message": "Sample message",
  "timestamp": "2026-04-09T00:39:30.636Z",
  "version": "2025-07-11"
}

Was this page helpful?