Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Accounts

Get details of an account

This endpoint will return an array of information about the account. You can retrieve the details of a Fire Account by its ican. You will need to enable PERM_BUSINESS_GET_ACCOUNT to use this endpoint.

get/v1/accounts/{ican}

Path parameters

icaninteger required

The ican of the account to retrieve

Response

An account object.

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
}