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

# Create Permanent Pay-In Deposit Wallet for Account

Generate a permanent deposit wallet for account pay-ins. Create a dedicated pay-in wallet for an account. Funds deposited to this wallet are automatically swept into the main account. This enables seamless fund aggregation and reduces manual processing.

# 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/{account_ref}/payin/address": {
      "post": {
        "tags": [
          "Partners"
        ],
        "summary": "Create Permanent Pay-In Deposit Wallet for Account",
        "description": "Generate a permanent deposit wallet for account pay-ins. Create a dedicated pay-in wallet for an account. Funds deposited to this wallet are automatically swept into the main account. This enables seamless fund aggregation and reduces manual processing.",
        "operationId": "create-pay-in-deposit-wallet",
        "parameters": [
          {
            "description": "Your own account reference identifier.",
            "in": "path",
            "name": "account_ref",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/partners.GetDepositAddressRequest"
              }
            }
          },
          "description": "body",
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/internal.Response-partners_GetDepositAddressResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/internal.ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "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": {
      "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"
          }
        }
      },
      "internal.Response-partners_GetDepositAddressResponse": {
        "properties": {
          "data": {
            "$ref": "#/components/schemas/partners.GetDepositAddressResponse"
          },
          "error": {
            "type": "boolean"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "models.AccountState": {
        "enum": [
          1,
          2,
          3
        ],
        "type": "integer",
        "x-enum-varnames": [
          "AccountStateUnknown",
          "AccountStatePending",
          "AccountStateReady"
        ]
      },
      "partners.GetDepositAddressRequest": {
        "required": [
          "reference",
          "chain_id"
        ],
        "properties": {
          "chain_id": {
            "description": "The blockchain network ID to create the deposit wallet on.",
            "type": "integer",
            "example": 137
          },
          "currency": {
            "description": "Optional currency filter. If omitted, the deposit wallet accepts all currencies enabled on the parent account for this chain.",
            "type": "string",
            "example": "USDC"
          },
          "reference": {
            "description": "A unique reference for this deposit wallet, typically a customer identifier. Used to look up the wallet on subsequent calls.",
            "type": "string",
            "example": "customer-001"
          }
        },
        "type": "object"
      },
      "partners.GetDepositAddressResponse": {
        "properties": {
          "account_id": {
            "type": "integer"
          },
          "address": {
            "type": "string"
          },
          "chain_id": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "reference": {
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/models.AccountState"
          }
        },
        "type": "object"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```