Create an Account

v1.0.0

Input

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "entity_id": {
      "type": "string",
      "description": "The identifier for the Entity that will own the Account."
    },
    "informational_entity_id": {
      "type": "string",
      "description": "The identifier of an Entity that, while not owning the Account, is associated with its activity. Its relationship to your group must be `informational`."
    },
    "name": {
      "type": "string",
      "description": "The name you choose for the Account."
    }
  }
}

Output

{
  "type": "object",
  "description": "Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.",
  "required": [
    "balances",
    "created_at",
    "currency",
    "entity_id",
    "id",
    "informational_entity_id",
    "interest_accrued",
    "interest_accrued_at",
    "name",
    "status",
    "type"
  ],
  "properties": {
    "balances": {
      "type": "object",
      "description": "The Account's balances in the minor unit of its currency. For dollars, for example, these values will represent cents.",
      "required": [
        "available_balance",
        "current_balance"
      ],
      "properties": {
        "available_balance": {
          "type": "integer",
          "description": "The Account's available balance, representing the current balance less any open Pending Transactions on the Account."
        },
        "current_balance": {
          "type": "integer",
          "description": "The Account's current balance, representing the sum of all posted Transactions on the Account."
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was created."
    },
    "currency": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account currency.",
      "enum": [
        "CAD",
        "CHF",
        "EUR",
        "GBP",
        "JPY",
        "USD"
      ]
    },
    "entity_id": {
      "type": "string",
      "description": "The identifier for the Entity the Account belongs to."
    },
    "id": {
      "type": "string",
      "description": "The Account identifier."
    },
    "informational_entity_id": {
      "type": "string",
      "description": "The identifier of an Entity that, while not owning the Account, is associated with its activity."
    },
    "interest_accrued": {
      "type": "string",
      "description": "The interest accrued but not yet paid, expressed as a string containing a floating-point value."
    },
    "interest_accrued_at": {
      "type": "string",
      "format": "date",
      "description": "The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which interest was accrued."
    },
    "name": {
      "type": "string",
      "description": "The name you choose for the Account."
    },
    "status": {
      "type": "string",
      "description": "The status of the Account.",
      "enum": [
        "open",
        "closed"
      ]
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `account`.",
      "enum": [
        "account"
      ]
    }
  }
}