---
updatedAt: 2025-09-08T22:30:12.000Z
agentTools:
  projectIndex: https://boomfi.readme.io/llms.txt
---

# Retrieve a Merchant Settlement Account by ID

The **Retrieve a Merchant Settlement Account** endpoint allows you to fetch details of an existing merchant settlement account using the account's unique ID. This includes all account information such as account type, supported currencies, blockchain details, and status. Use this endpoint to view specific account configurations and verify account details within BoomFi.

<HTMLBlock>{`
<style>
  :root {
    --callout-border: 0;
    --callout-border-radius: 4px;
    --text-color: #000000;

    /* Info Callout Colors */
    --info-light-bg: #DAF8FF;
    --info-light-border: #7CCEDF;
    --info-light-header: #57B3C7;
    --info-light-text: #283652;
    --info-light-link: #57B3C7;
    --info-dark-bg: #DAF8FF;
    --info-dark-border: #7CCEDF;
    --info-dark-header: #57B3C7;
    --info-dark-text: #97B5BC;
    --info-dark-link: #57B3C7;

    /* Okay Callout Colors */
    --okay-light-bg: #DFFFE8;
    --okay-light-border: #116E5F;
    --okay-light-header: #116E5F;
    --okay-light-text: #116E5F;
    --okay-light-link: #61AEA0;
    --okay-dark-bg: #DFFFE8;
    --okay-dark-header: #5BB2A4;
    --okay-dark-text: #7B9792;
    --okay-dark-link: #61AEA0;

    /* Default Callout Colors */
    --default-light-bg: #e8e8e8;
    --default-light-border: #ACACAC;
    --default-light-text: #8A8A8A;
    --default-dark-bg: #e8e8e8;
    --default-dark-text: #FFFFFF;

    /* Warn Callout Colors */
    --warn-light-bg: #fff9c2;
    --warn-light-border: #FFB293;
    --warn-light-header: #FF966B;
    --warn-light-text: #80776C;
    --warn-light-link: #FF966B;
    --warn-dark-bg: #fff9c2;
    --warn-dark-header: #FF966B;
    --warn-dark-text: #989693;
    --warn-dark-link: #FF966B;

    /* Error Callout Colors */
    --error-light-bg: #ffdada;
    --error-light-border: #FA94A6;
    --error-light-header: #FF728B;
    --error-light-text: #B56978;
    --error-light-link: #FF728B;
    --error-dark-bg: #ffdada;
    --error-dark-header: #FF728B;
    --error-dark-text: #C6A5AB;
    --error-dark-link: #FF728B;
  }

  .field-description blockquote,
  .markdown-body blockquote {
    border-left: 0;
  }

  .callout {
    border-radius: var(--callout-border-radius);
    border: var(--callout-border);
  }

  .callout .callout-heading p,
  .callout p,
  .callout ul {
    color: var(--text-color) !important;
  }

  @media (prefers-color-scheme: dark) {

    [data-color-mode="system"] .callout .callout-heading p,
    [data-color-mode="system"] .callout p,
    [data-color-mode="system"] .callout ul {
      color: var(--text-color) !important;
    }
  }

  [data-color-mode="dark"] .callout .callout-heading p,
  [data-color-mode="dark"] .callout p,
  [data-color-mode="dark"] .callout ul {
    color: var(--text-color) !important;
  }

  /* INFO CALLOUT */
  .callout.callout_info {
    background: var(--info-light-bg);
  }

  .callout.callout_info a {
    color: var(--info-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_info {
      background-color: var(--info-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_info a {
      color: var(--info-dark-link) !important;
    }
  }

  [data-color-mode="dark"] .callout.callout_info {
    background-color: var(--info-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_info a {
    color: var(--info-dark-link) !important;
  }

  /* INFO CALLOUT */

  /* OKAY CALLOUT */
  .callout.callout_okay {
    background: var(--okay-light-bg);
  }

  .callout.callout_okay a {
    color: var(--okay-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_okay {
      background-color: var(--okay-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_okay a {
      color: var(--okay-dark-link) !important;
    }
  }

  [data-color-mode="dark"] .callout.callout_okay {
    background-color: var(--okay-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_okay a {
    color: var(--okay-dark-link) !important;
  }

  /* OKAY CALLOUT */

  /* DEFAULT CALLOUT */
  .callout.callout_default {
    background: var(--default-light-bg);
  }

  .callout.callout_default a {
    color: var(--text-color) !important;
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_default {
      background-color: var(--default-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_default a {
      color: var(--text-color) !important;
    }

  }

  [data-color-mode="dark"] .callout.callout_default {
    background-color: var(--default-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_default a {
    color: var(--text-color) !important;
  }

  /* DEFAULT CALLOUT */

  /* WARN CALLOUT */
  .callout.callout_warn {
    background: var(--warn-light-bg);
  }

  .callout.callout_warn a {
    color: var(--warn-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_warn {
      background-color: var(--warn-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_warn a {
      color: var(--warn-dark-link);
    }
  }

  [data-color-mode="dark"] .callout.callout_warn {
    background-color: var(--warn-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_warn a {
    color: var(--warn-dark-link);
  }

  /* WARN CALLOUT */

  /* ERROR CALLOUT */
  .callout.callout_error {
    background: var(--error-light-bg);
  }

  .callout.callout_error a {
    color: var(--error-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_error {
      background-color: var(--error-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_error a {
      color: var(--error-dark-link);
    }
  }

  [data-color-mode="dark"] .callout.callout_error {
    background-color: var(--error-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_error a {
    color: var(--error-dark-link);
  }

  /* ERROR CALLOUT */

  img {
    border-radius: 14px !important;
    box-shadow: 0px 0px 4px rgba(0, 0, 0, 0.15);
  }

  .Sidebar-listWrapper6Q9_yUrG906C.rm-Sidebar-section:nth-child(3),
  .rm-Sidebar-section:nth-child(3), .rm-Sidebar-section:nth-child(4) {
    display: none;
  }

  .Select option {
    color: var(--color-input-text);
  }
</style>
`}</HTMLBlock>

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Accounts API",
    "version": "1.0",
    "description": "Merchant settlement account endpoints. These set of API can be used to list, create, update and delete\nmerchant settlement accounts. There will be uniqueness checking performed during the creation API call\nwhere (org_id, reference, chain_id, currency) has to be unique. The user could not create multiple \nmerchant settlement accounts with the same reference and chain_id having duplicated currencies"
  },
  "servers": [
    {
      "url": "https://mapi-test.boomfi.xyz"
    },
    {
      "url": "https://mapi.boomfi.xyz"
    }
  ],
  "tags": [
    {
      "name": "Settlement Accounts",
      "description": "Merchant settlemement accounts"
    }
  ],
  "paths": {
    "/v1/accounts/{accountId}": {
      "get": {
        "tags": [
          "Settlement Accounts"
        ],
        "summary": "Retrieve a Merchant Settlement Account by ID",
        "description": "The **Retrieve a Merchant Settlement Account** endpoint allows you to fetch details of an existing merchant settlement account using the account's unique ID. This includes all account information such as account type, supported currencies, blockchain details, and status. Use this endpoint to view specific account configurations and verify account details within BoomFi.\n",
        "operationId": "get-settlement-account-by-id",
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "description": "The unique identifier of the merchant settlement account to retrieve.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieves the merchant settlement account.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            }
          },
          "404": {
            "description": "The specified merchant settlement account does not exist."
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Account": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/AccountDetails"
          },
          "message": {
            "type": "string",
            "description": "A message indicating the result of the operation."
          }
        }
      },
      "AccountDetails": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "A unique identifier for the merchant settlement account."
          },
          "org_id": {
            "type": "string",
            "description": "The unique identifier of your organization."
          },
          "parent_id": {
            "type": "integer",
            "format": "int64",
            "nullable": true,
            "description": "The identifier of the parent merchant settlement account, if applicable."
          },
          "reference": {
            "type": "string",
            "description": "A reference code to group and manage multiple merchant settlement accounts."
          },
          "account_type": {
            "type": "string",
            "enum": [
              "CryptoPayIn",
              "CryptoPayOut",
              "FiatPayIn",
              "FiatPayOut",
              "Crypto",
              "Bank",
              "Card",
              "MPCVault",
              "GooglePay",
              "ApplePay"
            ],
            "description": "The type of merchant settlement account, indicating the settlement method."
          },
          "name": {
            "type": "string",
            "description": "The name assigned to the merchant settlement account."
          },
          "chain_id": {
            "type": "integer",
            "format": "int64",
            "description": "The blockchain network identifier (e.g., 1 for Ethereum Mainnet, 8453 for Base Mainnet)."
          },
          "address": {
            "type": "string",
            "description": "The wallet address associated with the merchant settlement account."
          },
          "currencies": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ETH",
                "USDC",
                "USDT",
                "WETH",
                "DAI",
                "SOL"
              ]
            },
            "description": "A list of currency codes that the account supports. Possible values are:\n- **ETH**: Ethereum\n- **USDC**: USD Coin\n- **USDT**: Tether\n- **WETH**: Wrapped Ether\n- **DAI**: Dai Stablecoin\n- **SOL**: Solana\n\nEnsure that the currencies listed are supported by the account's blockchain network and are relevant to your transaction needs.\n"
          },
          "account_number": {
            "type": "string",
            "description": "The account number for fiat settlement accounts. Empty if not applicable."
          },
          "sort_code": {
            "type": "string",
            "description": "The bank sort code for fiat settlement accounts. Empty if not applicable."
          },
          "enabled": {
            "type": "boolean",
            "description": "Indicates whether this merchant settlement account is currently enabled."
          },
          "state": {
            "type": "string",
            "enum": [
              "Unknown",
              "Pending",
              "Ready"
            ],
            "description": "The current state of the merchant settlement account."
          },
          "created_by": {
            "type": "string",
            "description": "The identifier of the user who created this account."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when the merchant settlement account was created."
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when the merchant settlement account was last updated."
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "The timestamp when the merchant settlement account was deleted, if applicable."
          }
        }
      }
    },
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```