v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Accounts

Create a new Fire Account.

This endpoint will create a new Fire account on your profile. You will need to enable PERM_BUSINESS_POST_ACCOUNTS to use this endpoint.

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

post/v1/accounts

Request body

accountNamestring

Name to give the new account

currency'EUR' | 'GBP'

The currency of the new account

acceptFeesAndChargesboolean

a field to indicate you accept the fee for a new account

Example request

{
  "accountName": "Operating Account"
}

Response

The details of the new account

icaninteger

identifier for the fire.com account (assigned by fire.com)

namestring

the name the user gives to the account to help them identify it.

colourstring

Internal Use

balanceinteger

the balance of the account (in minor currency units - pence, cent etc. 434050 == 4,340.50 GBP for a GBP account).

status'LIVE' | 'BREXIT_MIGRATED'

Live accounts can be used as normal. Migrated accounts were used before Brexit and are read-only.

cbicstring

the BIC of the account (provided if currency is EUR).

cibanstring

the IBAN of the account (provided if currency is EUR).

cnscstring

the Sort Code of the account.

ccanstring

the Account Number of the account.

defaultAccountboolean

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).

directDebitsAllowedboolean

Whether or not direct debits can be set up on this account.

fopOnlyboolean

Indicates that this account is for collecting Fire Open Payments only. All other payments to this account will be returned.

Example response

{
  "ican": 42,
  "name": "Main Account",
  "colour": "ORANGE",
  "currency": {
    "code": "EUR",
    "description": "Euro"
  },
  "balance": 23950,
  "cbic": "CPAYIE2D",
  "ciban": "IE54CPAY99119911111111",
  "cnsc": "232221",
  "ccan": "11111111",
  "defaultAccount": true
}