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
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.fire.com/business
auth: b e a r
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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
| method | path | what the vendor says it does |
|---|---|---|
GET | /v1/accounts | List all fire.com Accounts Returns all your fire.com Accounts. Ordered by Alias ascending. Can be paginated. A |
POST | /v1/accounts | Add a new account Creates a new fire.com account. **Please note there is a charge associated with creating a |
GET | /v1/accounts/{ican} | Retrieve the details of a fire.com Account You can retrieve the details of a fire.com Account by its `ican`. A |
GET | /v1/accounts/{ican}/transactions | List transactions for an account (v1) Retrieve a list of transactions against an account. Recommended to use t |
GET | /v1/accounts/{ican}/transactions/filter | Filtered list of transactions for an account (v1) Retrieve a filtered list of transactions against an account. |
POST | /v1/apps | Create a new API Application Create a new API Application with specified permissions API |
POST | /v1/apps/accesstokens | Authenticate with the API. Access to the API is by Bearer Tokens. The process is somewhat similar to OAuth2.0, |
GET | /v1/aspsps | Get list of ASPSPs / Banks Returns all ASPSPs (Account Servicing Payment Service Provider) / banks. The list c |
GET | /v1/batches | List batches Returns the list of batch with the specified types and statuses. Payment Batches |
POST | /v1/batches | Create a new batch of payments The fire.com API allows businesses to automate payments between their accounts |
GET | /v1/batches/{batchUuid} | Get details of a single Batch Returns the details of the batch specified in the API endpoint - {batchUuid}. Pa |
PUT | /v1/batches/{batchUuid} | Submit a batch for approval Submits the Batch (for approval in the case of a **BANK_TRANSFER**). If this is an |
DELETE | /v1/batches/{batchUuid} | Cancel a batch Cancels the Batch. You can only cancel a batch before it is submitted for approval (while it is |
GET | /v1/batches/{batchUuid}/approvals | List Approvers for a Batch Returns a list of approvers for this batch. Payment Batches |
GET | /v1/batches/{batchUuid}/banktransfers | List items in a Batch Returns a paginated list of items in the specified batch. Payment Batches |
POST | /v1/batches/{batchUuid}/banktransfers | Add a bank transfer payment to the batch. There are two ways to process bank transfers - by Payee ID (**Mode 1 |
DELETE | /v1/batches/{batchUuid}/banktransfers/{itemUuid} | Remove a Payment from the Batch (Bank Transfers) Removes a Payment from the Batch (Bank Transfers). You can on |
GET | /v1/batches/{batchUuid}/internaltransfers | List items in a Batch Returns a paginated list of items in the specified batch. Payment Batches |
POST | /v1/batches/{batchUuid}/internaltransfers | Add an internal transfer payment to the batch Simply specify the source account, destination account, amount a |
DELETE | /v1/batches/{batchUuid}/internaltransfers/{itemUuid} | Remove a Payment from the Batch (Internal Transfer) Removes a Payment from the Batch (Internal Transfer). You |
GET | /v1/cards | View List of Cards. Returns a list of cards related to your fire.com account. Cards |
POST | /v1/cards | Create a new debit card. You can create multiple debit cards which can be linked to your fire.com accounts. Ca |
POST | /v1/cards/{cardId}/block | Block a card Updates status of an existing card to block which prevents any transactions being carried out wit |
GET | /v1/cards/{cardId}/transactions | List Card Transactions. Returns a list of cards transactions related to your fire.com card. Cards |
POST | /v1/cards/{cardId}/unblock | Unblock a card Updates status of an existing card to unblock which means that transactions can be carried out |
GET | /v1/directdebits | Get all DD payments associated with a direct debit mandate Retrieve all direct debit payments associated with |
GET | /v1/directdebits/{directDebitUuid} | Get the details of a direct debit Retrieve all details of a single direct debit collection/payment, whether su |
POST | /v1/directdebits/{directDebitUuid}/reject | Reject a direct debit payment This endpoint allows you to reject a direct debit payment where the status is st |
GET | /v1/mandates | List all direct debit mandates The permision needed to access this endpoint is PERM_BUSINESS_GET_MANDATES Dire |
GET | /v1/mandates/{mandateUuid} | Get direct debit mandate details Retrieve all details for a direct debit mandate. The permision needed to acce |
POST | /v1/mandates/{mandateUuid} | Update a direct debit mandate alias Update Direct Debit Mandate Alias The permision needed to access this endp |
POST | /v1/mandates/{mandateUuid}/activate | Activate a direct debit mandate This endpoint can only be used to activate a direct debit mandate when it is i |
POST | /v1/mandates/{mandateUuid}/cancel | Cancel a direct debit mandate This endpoint allows you to cancel a direct debit mandate. The permision needed |
GET | /v1/payees | List all Payee Bank Accounts Returns all your payee bank accounts. Ordered by payee name ascending. Can be |
POST | /v1/paymentrequests | Create a Fire Open Payment request Fire Open Payments is a feature of the fire.com business account that lever |
GET | /v1/payments/{paymentUuid} | Get Payment Details Returns the details of a specific payment. As the customer goes through the process of ma |
GET | /v1/user/{userId} | Returns details of a specific fire.com user. You can retrieve the details of a specific fire.com user Users |
GET | /v1/users | Returns list of all users on your fire.com account You can retrieve the details of all fire.com users on your |
GET | /v3/accounts/{ican}/transactions | List transactions for an account (v3) Retrieve a list of transactions against an account. Initially, use the o |
specification origin: https://raw.githubusercontent.com/firefinancialservices/fire-business-api-openapi/master/f
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.