Fire

Fire Financial Services Business API

The fire.com API allows you to deeply integrate Business Account features into your application or back-office systems. The API provides read access to your…

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The fire.com API allows you to deeply integrate Business Account features into your application or back-office systems.

The API provides read access to your profile, accounts and transactions, event-driven notifications of activity on the account and payment initiation via batches. Each feature has its own HTTP endpoint and every endpoint has its own permission.

The API exposes 3 main areas of functionality: financial functions, service information and service configuration.

Financial Functions

These functions provide access to your account details, transactions, payee accounts, payment initiation etc.

Service Functions

These provide information about the fees and limits applied to your account.

Service configuration

These provide information about your service configs - applications, webhooks, API tokens, etc.

Endpoints 39

Authentication

  • POSTAuthenticate with the API./v1/apps/accesstokensAccess to the API is by Bearer Tokens. The process is somewhat similar to OAuth2.0, but with some changes to improve security. 1. You must first log into the…

Accounts

  • GETList all fire.com Accounts/v1/accountsReturns all your fire.com Accounts. Ordered by Alias ascending. Can be paginated.
  • POSTAdd a new account/v1/accountsCreates a new fire.com account. Please note there is a charge associated with creating a new account.
  • GETRetrieve the details of a fire.com Account/v1/accounts/:icanYou can retrieve the details of a fire.com Account by its ican.

Open Banking

  • GETGet list of ASPSPs / Banks/v1/aspsps?currency=EURReturns all ASPSPs (Account Servicing Payment Service Provider) / banks. The list can be filtered by currency. You will need to enable the…
  • POSTCreate a Fire Open Payment request/v1/paymentrequestsFire Open Payments is a feature of the fire.com business account that leverages Open Banking to allow your customers to pay you via bank transfer and to…
  • GETGet Payment Details/v1/payments/:paymentUuidReturns the details of a specific payment. As the customer goes through the process of making the payment the status of the payment will change. *…

API

  • POSTCreate a new API Application/v1/appsCreate a new API Application with specified permissions

Transactions

  • GETList transactions for an account (v1)/v1/accounts/:ican/transactions?limit=0&offset=0Deprecated. Retrieve a list of transactions against an account. Recommended to use the v3 endpoint instead.
  • GETFiltered list of transactions for an account (v1)/v1/accounts/:ican/transactions/filter?dateRangeFrom=0&dateRangeTo=0&searchKeyword=string&transactionTypes=string&offset=0Deprecated. Retrieve a filtered list of transactions against an account. Recommended to use the v3 endpoint instead. * dateRangeFrom - A millisecond epoch…
  • GETList transactions for an account (v3)/v3/accounts/:ican/transactions?limit=0&dateRangeFrom=0&dateRangeTo=0&startAfter=stringRetrieve a list of transactions against an account. Initially, use the optional limit, dateRangeFrom and dateRangeTo query params to limit your query, then…

Direct Debits

  • GETGet all DD payments associated with a direct debit mandate/v1/directdebits?mandateUuid=1A07774B-1461-4595-BC4B-423B739712AFRetrieve all direct debit payments associated with a direct debit mandate. The permision needed to access this endpoint is PERM_BUSINESS_GET_DIRECT_DEBITS
  • GETGet the details of a direct debit/v1/directdebits/:directDebitUuidRetrieve all details of a single direct debit collection/payment, whether successful or not. The permision needed to access this endpoint is…
  • POSTReject a direct debit payment/v1/directdebits/:directDebitUuid/rejectThis endpoint allows you to reject a direct debit payment where the status is still set to RECEIVED. Permission name PERM_BUSINESS_POST_DIRECT_DEBIT_REJECT
  • GETList all direct debit mandates/v1/mandatesThe permision needed to access this endpoint is PERM_BUSINESS_GET_MANDATES
  • GETGet direct debit mandate details/v1/mandates/:mandateUuidRetrieve all details for a direct debit mandate. The permision needed to access this endpoint is PERM_BUSINESS_GET_MANDATE
  • POSTUpdate a direct debit mandate alias/v1/mandates/:mandateUuidUpdate Direct Debit Mandate Alias The permision needed to access this endpoint is PERM_BUSINESS_PUT_MANDATE
  • POSTActivate a direct debit mandate/v1/mandates/:mandateUuid/activateThis endpoint can only be used to activate a direct debit mandate when it is in the status REJECT_REQUESTED (even if the account has direct debits disabled).…
  • POSTCancel a direct debit mandate/v1/mandates/:mandateUuid/cancelThis endpoint allows you to cancel a direct debit mandate. The permision needed to access this endpoint is PERM_BUSINESS_POST_MANDATE_CANCEL

Payment Batches

  • GETList batches/v1/batches?batchStatus=SUBMITTED&batchTypes=INTERNAL_TRANSFER&orderBy=DATE&order=DESCReturns the list of batch with the specified types and statuses.
  • POSTCreate a new batch of payments/v1/batchesThe fire.com API allows businesses to automate payments between their accounts or to third parties across the UK and Europe. For added security, the API can…
  • GETGet details of a single Batch/v1/batches/:batchUuidReturns the details of the batch specified in the API endpoint - {batchUuid}.
  • PUTSubmit a batch for approval/v1/batches/:batchUuidSubmits the Batch (for approval in the case of a BANK_TRANSFER). If this is an INTERNAL_TRANSFER batch, the transfers are immediately queued for processing.…
  • DELETECancel a batch/v1/batches/:batchUuidCancels the Batch. You can only cancel a batch before it is submitted for approval (while it is in the OPEN state).
  • GETList Approvers for a Batch/v1/batches/:batchUuid/approvalsReturns a list of approvers for this batch.
  • GETList items in a Batch/v1/batches/:batchUuid/banktransfers?offset=0&limit=10Returns a paginated list of items in the specified batch.
  • POSTAdd a bank transfer payment to the batch./v1/batches/:batchUuid/banktransfersThere are two ways to process bank transfers - by Payee ID (Mode 1) or by Payee Account Details (Mode 2). Mode 1: Use the payee IDs of existing approved…
  • DELETERemove a Payment from the Batch (Bank Transfers)/v1/batches/:batchUuid/banktransfers/:itemUuidRemoves a Payment from the Batch (Bank Transfers). You can only remove payments before the batch is submitted for approval (while it is in the OPEN state).
  • GETList items in a Batch/v1/batches/:batchUuid/internaltransfers?offset=0&limit=10Returns a paginated list of items in the specified batch.
  • POSTAdd an internal transfer payment to the batch/v1/batches/:batchUuid/internaltransfersSimply specify the source account, destination account, amount and a reference.
  • DELETERemove a Payment from the Batch (Internal Transfer)/v1/batches/:batchUuid/internaltransfers/:itemUuidRemoves a Payment from the Batch (Internal Transfer). You can only remove payments before the batch is submitted for approval (while it is in the OPEN state).

Cards

  • GETView List of Cards./v1/cardsReturns a list of cards related to your fire.com account.
  • POSTCreate a new debit card./v1/cardsYou can create multiple debit cards which can be linked to your fire.com accounts.
  • POSTBlock a card/v1/cards/:cardId/blockUpdates status of an existing card to block which prevents any transactions being carried out with that card.
  • GETList Card Transactions./v1/cards/:cardId/transactions?limit=0&offset=0Returns a list of cards transactions related to your fire.com card.
  • POSTUnblock a card/v1/cards/:cardId/unblockUpdates status of an existing card to unblock which means that transactions can be carried out with that card.

Payee Bank Accounts

  • GETList all Payee Bank Accounts/v1/payeesReturns all your payee bank accounts. Ordered by payee name ascending. Can be paginated.

Users

  • GETReturns details of a specific fire.com user./v1/user/:userIdYou can retrieve the details of a specific fire.com user
  • GETReturns list of all users on your fire.com account/v1/usersYou can retrieve the details of all fire.com users on your acount.

API details

Base URL
https://api.fire.com/business
Authentication
A bearer token in the Authorization header
Operations
39 operations on 31 pathsGET 21POST 14DELETE 3PUT 1
2 marked deprecated
Main resources
Payment Batches 12Direct Debits 8Cards 5Accounts 3Open Banking 3Transactions 3Users 2API 1Authentication 1Payee Bank Accounts 1
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Fire Financial Services Business API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Fire Financial Services Business API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Authenticate with the API.” (POST /v1/apps/accesstokens), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Fire Financial Services Business API?

The fire.com API allows you to deeply integrate Business Account features into your application or back-office systems. The API provides read access to your… It is listed under Finance & banking and has 39 endpoints.

Who publishes the Fire Financial Services Business API?

It is listed from Fire's public API description (an OpenAPI document), not published by Fire on Swastik Codes. Anyone who controls fire.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Fire Financial Services Business API?

Requests go to https://api.fire.com/business. Endpoint paths are added to this base URL.

How do I authenticate with the Fire Financial Services Business API?

With A bearer token in the Authorization header.

How many endpoints does the Fire Financial Services Business API have?

39 operations on 31 paths (21 GET, 14 POST, 3 DELETE, 1 PUT). The largest groups are Payment Batches, Direct Debits, Cards, Accounts.

Is forking the Fire Financial Services Business API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.