---
updatedAt: 2026-03-09T11:06:19.000Z
agentTools:
  projectIndex: https://boomfi.readme.io/llms.txt
---

# Create Virtual Account

Create a virtual account with crypto wallets across supported networks. Supports both managed (DFNS) wallets and external (self-custody) wallets. Optionally configure deposit splits to automatically route portions of incoming deposits to other virtual accounts.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "contact": {
      "email": "support@boomfi.xyz",
      "name": "API Support"
    },
    "description": "The BoomFi Partners API provides a set of endpoints for patners to manage their accounts, transactions, and more.",
    "title": "BoomFi Partners API",
    "version": "1.0"
  },
  "paths": {
    "/partners/accounts/create-virtual-account": {
      "post": {
        "tags": [
          "Partners"
        ],
        "summary": "Create Virtual Account",
        "description": "Create a virtual account with crypto wallets across supported networks. Supports both managed (DFNS) wallets and external (self-custody) wallets via the wallet_address field on chain configurations. Optionally configure deposit splits to automatically route portions of incoming deposits to other virtual accounts.",
        "operationId": "create-virtual-account",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/partners.CreateVirtualAccountRequest"
              }
            }
          },
          "description": "Request",
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/internal.Response-accounts_OrgSettlementAccountResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/internal.ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/internal.ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          },
          {
            "ApiSignature": []
          },
          {
            "ApiNonce": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "//mapi.boomfi.xyz"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      },
      "ApiNonce": {
        "in": "header",
        "name": "X-API-Nonce",
        "type": "apiKey"
      },
      "ApiSignature": {
        "in": "header",
        "name": "X-API-Signature",
        "type": "apiKey"
      }
    },
    "schemas": {
      "accounts.ChainResponse": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "description": "The category or classification of the chain."
          },
          "code": {
            "type": "string",
            "description": "The code or abbreviation associated with the chain."
          },
          "is_testnet": {
            "type": "boolean",
            "description": "Indicates whether the chain is a testnet (true) or not (false)."
          },
          "name": {
            "type": "string",
            "description": "The name or title associated with the chain."
          },
          "native_currency_symbol": {
            "type": "string",
            "description": "The symbol representing the native currency of the chain."
          }
        }
      },
      "accounts.OrgSettlementAccountResponse": {
        "type": "object",
        "properties": {
          "account_number": {
            "description": "The account number.",
            "type": "string",
            "example": "123456789"
          },
          "account_type": {
            "description": "The type of the account.",
            "allOf": [
              {
                "$ref": "#/components/schemas/models.AccountType"
              }
            ]
          },
          "address": {
            "description": "The cryptocurrency wallet address associated with a specific account.",
            "type": "string",
            "example": "0x4bbeEB066eD09B7AEd07bF39EEe0460DFa261520"
          },
          "chain": {
            "$ref": "#/components/schemas/accounts.ChainResponse"
          },
          "chain_id": {
            "description": "The unique identifier representing a blockchain network or chain.",
            "type": "integer",
            "example": 1
          },
          "created_at": {
            "description": "The timestamp indicating when the entity was created.",
            "type": "string",
            "example": "2023-01-01T12:00:00Z"
          },
          "created_by": {
            "description": "Information about the user or entity that created the entry.",
            "type": "string",
            "example": "user123"
          },
          "currencies": {
            "description": "An array containing the names or symbols of the currencies supported.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "BTC",
              "ETH",
              "USD"
            ]
          },
          "deleted_at": {
            "description": "The timestamp indicating when the account was deleted.",
            "type": "string",
            "example": "2023-01-02T08:30:00Z"
          },
          "enabled": {
            "description": "Indicates whether the account is currently enabled.",
            "type": "boolean",
            "example": true
          },
          "id": {
            "description": "The unique identifier for the account.",
            "type": "integer",
            "example": 123456
          },
          "name": {
            "description": "The name or title associated with the account.",
            "type": "string",
            "example": "Primary Account"
          },
          "org_id": {
            "description": "The identifier representing the organization associated with the account.",
            "type": "string",
            "example": "org123"
          },
          "properties": {
            "type": "object",
            "additionalProperties": {}
          },
          "provider": {
            "$ref": "#/components/schemas/models.AccountProvider"
          },
          "sort_code": {
            "description": "The sort code associated with the account.",
            "type": "string",
            "example": "123456"
          },
          "updated_at": {
            "description": "The timestamp indicating when the entity was last updated.",
            "type": "string",
            "example": "2023-01-03T10:45:00Z"
          }
        }
      },
      "internal.ErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "$ref": "#/components/schemas/internal.ErrorStruct"
          }
        }
      },
      "internal.ErrorStruct": {
        "type": "object",
        "properties": {
          "code": {
            "description": "The error code returned by the server.\nExample: 400",
            "type": "integer",
            "example": 400
          },
          "errors": {
            "description": "A list of detailed error objects.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/internal.SingleError"
            }
          },
          "message": {
            "description": "A descriptive message explaining the error.\nExample: Insufficient quantity",
            "type": "string",
            "example": "Insufficient quantity"
          }
        }
      },
      "internal.SingleError": {
        "type": "object",
        "properties": {
          "domain": {
            "description": "The domain associated with the error.\nExample: orders",
            "type": "string",
            "example": "orders"
          },
          "reason": {
            "description": "The reason for the error.\nExample: InsufficientQuantity",
            "type": "string",
            "example": "InsufficientQuantity"
          }
        }
      },
      "models.AccountProvider": {
        "description": "The account provider.\n- 1 = Spreedly",
        "type": "integer",
        "enum": [
          1
        ],
        "x-enum-varnames": [
          "AccountProviderSpreedly"
        ]
      },
      "models.AccountType": {
        "description": "The type of the current account.\n- 1 = Crypto - 2 = Bank - 3 = Card",
        "type": "integer",
        "enum": [
          1,
          2,
          3
        ],
        "x-enum-varnames": [
          "AccountTypeCrypto",
          "AccountTypeBank",
          "AccountTypeCard"
        ]
      },
      "internal.Response-accounts_OrgSettlementAccountResponse": {
        "properties": {
          "data": {
            "$ref": "#/components/schemas/accounts.OrgSettlementAccountResponse"
          },
          "error": {
            "type": "boolean"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "partners.CreateVirtualAccountRequest": {
        "type": "object",
        "required": [
          "name",
          "reference"
        ],
        "properties": {
          "name": {
            "description": "A descriptive name to identify the account.",
            "type": "string"
          },
          "reference": {
            "description": "Your own account reference identifier. Must be URL-safe, containing only alphanumeric characters, hyphens, and underscores (no spaces or special characters).",
            "type": "string"
          },
          "chains": {
            "description": "Blockchain configurations for the virtual account. Each entry creates a sub-account on the specified chain. Entries without wallet_address create managed (DFNS) wallets; entries with wallet_address create external (self-custody) sub-accounts.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/partners.ChainConfig"
            }
          },
          "deposit_splits": {
            "description": "Configure automatic splitting of incoming deposits. Each entry routes a percentage of the gross deposit amount to the specified destination account. The remainder (after BoomFi fees and all splits) goes to the virtual account's own external wallet.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/partners.DepositSplitInput"
            }
          }
        }
      },
      "partners.ChainConfig": {
        "type": "object",
        "properties": {
          "chain_id": {
            "description": "The blockchain network ID.",
            "type": "integer",
            "example": 1
          },
          "currencies": {
            "description": "List of currency symbols to enable on this chain.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "USDT",
              "USDC"
            ]
          },
          "wallet_address": {
            "description": "External wallet address for this chain. When provided, creates an external (self-custody) sub-account instead of a managed wallet. Omit for managed (DFNS) wallets.",
            "type": "string",
            "example": "0x4bbeEB066eD09B7AEd07bF39EEe0460DFa261520"
          }
        }
      },
      "partners.DepositSplitInput": {
        "type": "object",
        "required": [
          "pct"
        ],
        "properties": {
          "account_ref": {
            "description": "Reference of the target virtual account to receive this split. Exactly one of account_ref or account_id must be provided.",
            "type": "string",
            "example": "my-fee-account"
          },
          "account_id": {
            "description": "ID of the target virtual account to receive this split. Exactly one of account_ref or account_id must be provided.",
            "type": "integer",
            "example": 12345
          },
          "pct": {
            "description": "Percentage of gross deposit amount to route to this destination. Use decimal string (e.g. \"2.5\" for 2.5%).",
            "type": "string",
            "example": "2.5"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```