Fire Financial Services Business API

Activate a direct debit mandate This 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). This action will also enable the account for direct debits if it was previously set to be disabled. You will need to enable PERM_BUSINESS_POST_MANDATE_ACTIVATE to use this endpoint.

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

Add a bank transfer to a batch. This endpoint will add a new bank transfer payment to a batch. There 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 payees set up against your account. These batches can be approved in the normal manner. **Mode 2:** Use the account details of the payee. In the event that these details correspond to an existing approved payee, the batch can be approved as normal. If the account details are new, a batch of New Payees will automatically be created. This batch will need to be approved before the Payment batch can be approved. These payees will then exist as approved payees for future batches. You will need to enable PERM_BUSINESS_POST_BATCH_BANKTRANSFERS to use this endpoint.

Add an internal transfer to a Batch This endpoint will add an internal transfer payment to an existing batch. Simply specify the source account, destination account, amount and a reference. You will need to enable PERM_BUSINESS_POST_BATCH_INTERNALTRANSFERS to use this endpoint.

Add an international transfer to a Batch This endpoint allows you to add an international transfer to a batch. International transfers must be added to a batch using the Payee ID (**Mode 1**). Payees must be set up using the web application. **Mode 1:** Use the payee IDs of existing approved payees set up against your account. These batches can be approved in the normal manner.

Authenticate with the API. This endpoint is needed to generate your access token. Access to the API is by Bearer Access Tokens. These are valid for 15 minutes. You can have multiple Access Tokens active at the same time if needed. See the [Guide to Authentication](/docs/authentication) for full details.

Block a Fire debit card This endpoint allows you to block a card on your Fire account. This updates the status of an existing card to block which prevents any transactions being carried out with that card. You will need to enable PERM_BUSINESS_POST_MY_CARD_BLOCK to use this endpoint.

Cancel a batch This endpoint will cancel a Batch from being processed. You can only cancel a batch before it is submitted for approval (while it is in the OPEN state). You will need to enable PERM_BUSINESS_DELETE_BATCH to use this endpoint.

Cancel a direct debit mandate This endpoint allows you to cancel a direct debit mandate. You will need to enable PERM_BUSINESS_POST_MANDATE_CANCEL to use this endpoint.

Create an API Application This endpoint will create a new API Application on your Fire account with your chosen specified permissions. Please note that if there is no batch approval permissions included, the approval fields must be set to null. You will need to enable PERM_BUSINESS_POST_APPS to use this endpoint.

Create a new batch This endpoint will create a new batch. This opens a new batch container to hold specific transaction types in a certain currency. You will need to enable PERM_BUSINESS_POST_BATCHES to use this endpoint.

Create a new Fire debit card This endpoint allows you to create a debit card to be linked to your Fire account. You can create multiple debit cards which can be linked to your Fire accounts. You will need to enable PERM_BUSINESS_POST_CARDS to use this endpoint.

Remove a bank transfer from a batch. This endpoint will remove 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). You will need to enable PERM_BUSINESS_DELETE_BATCH_BANKTRANSFERS to use this endpoint.

Remove an internal transfer from a batch This endpoint will remove 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). You will need to enable PERM_BUSINESS_DELETE_BATCH_INTERNALTRANSFERS to use this endpoint.

Remove an international transfer from a batch This endpoint will remove a payment from an existing Batch (International Transfers). You can only remove payments before the batch is submitted for approval (while it is in the OPEN state). You will need to enable PERM_BUSINESS_DELETE_BATCH_INTERNATIONALTRANSFERS to use this endpoint.

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 details of an account (V2) 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.

List accounts This endpoint returns all the accounts on your Fire profile. Ordered by Alias ascending. Can be paginated. You will need to enable PERM_BUSINESS_GET_ACCOUNTS to use this endpoint.

List accounts (V2) This endpoint returns all the accounts on your Fire profile. Ordered by Alias ascending. Can be paginated. You will need to enable PERM_BUSINESS_GET_ACCOUNTS to use this endpoint.

Get activity This endpoint will retrieve the details of all activity on your Fire Accounts. You will need to enable PERM_BUSINESS_GET_ACTIVITIES to use this endpoint.

List all permissions for API applications This endpoint will list all permissions available for any API application you have created on your Fire account. You will need to enable PERM_BUSINESS_GET_APPS_PERMISSIONS to use this endpoint.

List all API applications This endpoint returns a list of API applications created under your Fire account. You will need to enable PERM_BUSINESS_GET_APPS to use this endpoint.

List all batches This endpoint will return a list of batches with the specified types and statuses. You will need to enable PERM_BUSINESS_GET_BATCHES to use this endpoint.

Get the details of a batch This endpoint will return the details of the batch specified in the API endpoint - {batchUuid}. You will need to enable PERM_BUSINESS_GET_BATCH to use this endpoint.

Get the details of a direct debit This endpoint will retrieve all details of a single direct debit collection/payment, whether successful or not. You will need to enable PERM_BUSINESS_GET_DIRECT_DEBIT to use this endpoint.

List all direct debit mandates This endpoint will list all mandates on your Fire account. You will need to enable PERM_BUSINESS_GET_MANDATES to use this endpoint.

List all direct debits This endpoint will retrieve all direct debit payments associated with a direct debit mandate. You will need to enable PERM_BUSINESS_GET_DIRECT_DEBITS to use this endpoint.

Get FX rates This endpoint returns the exchange rate between two currencies. You will need to enable PERM_BUSINESS_GET_FX_RATE to use this endpoint.

List items for a bank transfer batch This endpoint returns a paginated list of items in the specified batch. You will need to enable PERM_BUSINESS_GET_BATCH_BANKTRANSFERS to use this endpoint.

List items for an internal transfer batch This endpoint returns returns a paginated list of items in the specified batch. You will need to enable PERM_BUSINESS_GET_BATCH_INTERNALTRANSFERS to use this endpoint.

List items for an international transfer batch Returns a paginated list of items in the specified batch. You will need to enable PERM_BUSINESS_GET_BATCH_INTERNATIONALTRANSFERS to use this endpoint.

List all limits This endpoint returns an array of limit information. You will need to enable PERM_BUSINESS_GET_LIMITS to use this endpoint.

Get list of ASPSPs / Banks This endpoint will return all ASPSPs (Account Servicing Payment Service Provider) / banks available to you for open banking payments. The list can be filtered by currency.You will need to enable PERM_BUSINESS_GET_ASPSPS to use this endpoint. ***This endpoint is only required if you intend to host the “Select ASPSP / bank” page yourself.***

List approvals for a batch. This endpoint will return a list of the approvers for the selected batch. You will need to enable PERM_BUSINESS_GET_BATCH_APPROVALS to use this endpoint.

Get a list of debit card transactions This endpoint returns a list of cards transactions related to your Fire card. You will need to enable PERM_BUSINESS_GET_MY_CARD_TRANSACTIONS to use this endpoint.

List debit cards This endpoint returns a list of cards related to your Fire account. You will need to enable PERM_BUSINESS_GET_CARDS to use this endpoint.

Get the details of a direct debit mandate This endpoint will allow you to retrieve all details for a direct debit mandate. You will need to enable PERM_BUSINESS_GET_MANDATE to use this endpoint.

List new payees in a batch This endpoint will retrieve a list of details of batch items with new payees. You will need to enable PERM_BUSINESS_GET_BATCH_NEWPAYEES to use this endpoint.

Get details of a payee This endpoint will retrieve the details of a specific payee. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCE to use this endpoint.

List transaction for a payee account This endpoint retrieves the list of transactions and transaction information associated with a payee. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCE_TRANSACTIONS to use this endpoint.

List payees This endpoint will return all payees on your account. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCES to use this endpoint.

Get payment details This endpoint will return the details of a specific open banking payment. You will need to enable PERM_BUSINESS_GET_PAYMENT to use this endpoint. As your customer goes through the payment submission journey, the payment status will change. The endpoint will return one of the following statuses: * `AWAITING_AUTHORISATION` - This is the initial status of all payments, indicating that the user has consented to be directed to their ASPSP/Bank's application. Payments remaining at this status may be considered abandoned. * `AWAITING_MULTI_AUTHORISATION` - Some business accounts require dual authorisation for payments. * `NOT_AUTHORISED` - This is a final status, and indicates that the payment initiation was cancelled by the customer, rejected by the ASPSP/Bank, an error response returned by the ASPSP/Bank, eg. low balance in the customers account. * `PENDING` - The customer has authorised the payment in their app, but their ASPSP/bank may want to carry out an internal check before funding the transaction. * `AUTHORISED` - The payment is successfully initiated, having been authorised by your customer and their ASPSP/Bank. Once the payment is successfully initiated, ie. `AUTHORISED`, the ASPSP/Bank should settle the funds, which are then applied to your Fire account. * `FUNDS_CONFIRMED` - This status is currently available for GBP payments only. The payment has been received by Fire and will be applied to your account in the next file run. * `SETTLED` - This is a final status, indicating that funds have been applied to your Fire GBP or EUR account.

Get payment request details This endpoint will retrieve the details of an Open Banking Payment requestYou will need to enable PERM_BUSINESS_GET_PAYMENT_REQUEST to use this endpoint.

Get list of all payment attempts related to a payment request This endpoint will retrieve the list of payments attempted against an Open Banking Payment request. You will need to enable PERM_BUSINESS_GET_PAYMENT_REQUEST_PAYMENTS to use this endpoint.

Get a report from a payment request This endpoint will retrieve a report for an Open Banking Payment request. You will need to enable PERM_BUSINESS_GET_PAYMENT_REQUEST_REPORTS to use this endpoint.

Get a list of payment request transactions This endpoint will retrieve the list of open banking payment requests made on your account. You will need to enable PERM_BUSINESS_GET_PAYMENT_REQUEST_TRANSACTIONS to use this endpoint.

List all permissions for an API application This endpoint will return all permissions you selected for a specific API application on your Fire account. You will need to enable PERM_BUSINESS_GET_APP_PERMISSIONS to use this endpoint.

List details of a public payment request This endpoint returns an object of payment request information. You will need to enable PERM_BUSINESS_GET_PUBLIC_PAYMENT_REQUEST to use this endpoint.

Get service Fees and info This endpoint returns an array of the services and fees associated with them. You will need to enable PERM_BUSINESS_GET_SERVICES to use this endpoint.

List transactions for an account This endpoint will retrieve a list of transactions against an account. Initially, use the optional `limit`, `dateRangeFrom` and `dateRangeTo` query params to limit your query, then use the embedded `next` or `prev` links in the response to get newer or older pages. You will need to enable PERM_BUSINESS_GET_ACCOUNT_TRANSACTIONS to use this endpoint.