Add a new account

v1.0.0

Creates a new fire.com account.

Please note there is a charge associated with creating a new account.

Input

{
  "type": "object",
  "properties": {
    "acceptFeesAndCharges": {
      "type": "boolean",
      "description": "a field to indicate you accept the fee for a new account"
    },
    "accountName": {
      "type": "string",
      "description": "Name to give the new account"
    },
    "currency": {
      "type": "string",
      "description": "The currency of the new account",
      "enum": [
        "EUR",
        "GBP"
      ]
    }
  }
}

Output

{
  "type": "object",
  "properties": {
    "balance": {
      "type": "integer",
      "format": "int64",
      "description": "the balance of the account (in minor currency units - pence, cent etc. 434050 == 4,340.50 GBP for a GBP account)."
    },
    "cbic": {
      "type": "string",
      "description": "the BIC of the account (provided if currency is EUR)."
    },
    "ccan": {
      "type": "string",
      "description": "the Account Number of the account."
    },
    "ciban": {
      "type": "string",
      "description": "the IBAN of the account (provided if currency is EUR)."
    },
    "cnsc": {
      "type": "string",
      "description": "the Sort Code of the account."
    },
    "colour": {
      "type": "string",
      "description": "Internal Use"
    },
    "currency": {
      "type": "object",
      "description": "The currency.",
      "properties": {
        "code": {
          "type": "string",
          "description": "The three letter code for the currency - either `EUR` or `GBP`.",
          "enum": [
            "EUR",
            "GBP"
          ]
        },
        "description": {
          "type": "string",
          "description": "The name of the currency"
        }
      }
    },
    "defaultAccount": {
      "type": "boolean",
      "description": "true if this is the default account for this currency. This will be the account that general fees are taken from (as opposed to per-transaction fees)."
    },
    "directDebitsAllowed": {
      "type": "boolean",
      "description": "Whether or not direct debits can be set up on this account."
    },
    "fopOnly": {
      "type": "boolean",
      "description": "Indicates that this account is for collecting Fire Open Payments only. All other payments to this account will be returned."
    },
    "ican": {
      "type": "integer",
      "format": "int64",
      "description": "identifier for the fire.com account (assigned by fire.com)"
    },
    "name": {
      "type": "string",
      "description": "the name the user gives to the account to help them identify it."
    },
    "status": {
      "type": "string",
      "description": "Live accounts can be used as normal. Migrated accounts were used before Brexit and are read-only.",
      "enum": [
        "LIVE",
        "BREXIT_MIGRATED"
      ]
    }
  }
}