Bearer auth (http)
Send a bearer token
(“API Access Token” Formatted)
in the Authorization
http header
to authenticate with the 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 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.
These functions provide access to your account details, transactions, payee accounts, payment initiation etc.
These provide information about the fees and limits applied to your account.
These provide information about your service configs - applications, webhooks, API tokens, etc.
This is the documentation for version 1.0
of the API. Last update on Dec 3, 2022.
https://api.fire.com/business
Send a bearer token
(“API Access Token” Formatted)
in the Authorization
http header
to authenticate with the API.
Access to the API is by Bearer Tokens. The process is somewhat similar to OAuth2.0, but with some changes to improve security.
You now use these pieces of data to retrieve a short-term Access Token which you can use to access the API. The Access Token expires within a relatively short time, so even if it is compromised, the attacker will not have long to use it. The Client Key is the most important piece of information to keep secret. This should only ever be stored on a backend server, and never in a front end client or mobile app.
If you ever accidentally reveal the Client Key (or accidentally commit it to Github for instance) it is vital that you log into firework online and delete/recreate the App Tokens as soon as possible. Anyone who has these three pieces of data can access the API to view your data and set up payments from your account (depending on the scope of the tokens).
Once you have the access token, pass it as a header for every call, like so:
Authorization: Bearer $ACCESS_TOKEN
Whenever it expires, create a new nonce and get a new access token again.
Access to the API is by Bearer Tokens. The process is somewhat similar to OAuth2.0, but with some changes to improve security.
You must first log into the firework online application and create a new Application in the Profile > API page. (You will need your PIN digits and 2-Factor Authentication device).
Give your application a Name and select the scope/permissions you need the application to have (more on Scopes below).
You will be provided with three pieces of information - the App Refresh Token, Client ID and Client Key. You need to take note of the Client Key when it is displayed - it will not be shown again.
You now use these pieces of data to retrieve a short-term Access Token which you can use to access the API. The Access Token expires within a relatively short time, so even if it is compromised, the attacker will not have long to use it. The Client Key is the most important piece of information to keep secret. This should only ever be stored on a backend server, and never in a front end client or mobile app.
If you ever accidentally reveal the Client Key (or accidentally commit it to Github for instance) it is vital that you log into firework online and delete/recreate the App Tokens as soon as possible. Anyone who has these three pieces of data can access the API to view your data and set up payments from your account (depending on the scope of the tokens).
Once you have the access token, pass it as a header for every call, like so:
Authorization: Bearer $ACCESS_TOKEN
Whenever it expires, create a new nonce and get a new access token again.
Authentication data
The Client ID for this API Application
The Refresh Token for this API Application
A random non-repeating number used as a salt for the clientSecret
below. The simplest nonce is a unix time.
Always AccessToken
. (This will change to refresh_token
in a future release.)
Value is AccessToken
.
The SHA256 hash of the nonce above and the app’s Client Key. The Client Key will only be shown to you when you create the app, so don’t forget to save it somewhere safe. SECRET=( /bin/echo -n $NONCE$CLIENT_KEY | sha256sum
).
curl \
-X POST https://api.fire.com/business/v1/apps/accesstokens \
-H "Content-Type: application/json" \
-d '{"clientId":"4ADFB67A-0F5B-4A9A-9D74-34437250045C","refreshToken":"4ADFB67A-0F5B-4A9A-9D74-34437250045C","nonce":728345638475,"grantType":"AccessToken","clientSecret":"4ADFB67A-0F5B-4A9A-9D74-34437250045C"}'
{
"clientId": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
"refreshToken": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
"nonce": 728345638475,
"grantType": "AccessToken",
"clientSecret": "4ADFB67A-0F5B-4A9A-9D74-34437250045C"
}
{
"businessId": 248,
"apiApplicationId": 433,
"expiry": "2020-10-22T07:48:56.460Z",
"permissions": [
"PERM_BUSINESSES_GET_ACCOUNTS",
"PERM_BUSINESSES_GET_ACCOUNT_TRANSACTIONS"
],
"accessToken": "4ADFB67A-0F5B-4A9A-9D74-34437250045C"
}
fire.com Accounts are the equivalent of a bank account from bank.
Returns all your fire.com Accounts. Ordered by Alias ascending. Can be paginated.
curl \
-X GET https://api.fire.com/business/v1/accounts \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"accounts": [
{
"ican": 42,
"name": "Main Account",
"colour": "ORANGE",
"currency": {
"code": "EUR",
"description": "Euro"
},
"balance": 23950,
"status": "LIVE",
"cbic": "CPAYIE2D",
"ciban": "IE54CPAY99119911111111",
"cnsc": "232221",
"ccan": "11111111",
"defaultAccount": true,
"directDebitsAllowed": false,
"fopOnly": false
}
]
}
Creates a new fire.com account.
Please note there is a charge associated with creating a new account.
Details of the new account
Name to give the new account
Maximum length is 50
.
The currency of the new account
Values are EUR
or GBP
.
a field to indicate you accept the fee for a new account
curl \
-X POST https://api.fire.com/business/v1/accounts \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"accountName":"Operating Account","currency":"EUR","acceptFeesAndCharges":true}'
{
"accountName": "Operating Account",
"currency": "EUR",
"acceptFeesAndCharges": true
}
{
"ican": 42,
"name": "Main Account",
"colour": "ORANGE",
"currency": {
"code": "EUR",
"description": "Euro"
},
"balance": 23950,
"status": "LIVE",
"cbic": "CPAYIE2D",
"ciban": "IE54CPAY99119911111111",
"cnsc": "232221",
"ccan": "11111111",
"defaultAccount": true,
"directDebitsAllowed": false,
"fopOnly": false
}
You can retrieve the details of a fire.com Account by its ican
.
curl \
-X GET https://api.fire.com/business/v1/accounts/{ican} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"ican": 42,
"name": "Main Account",
"colour": "ORANGE",
"currency": {
"code": "EUR",
"description": "Euro"
},
"balance": 23950,
"status": "LIVE",
"cbic": "CPAYIE2D",
"ciban": "IE54CPAY99119911111111",
"cnsc": "232221",
"ccan": "11111111",
"defaultAccount": true,
"directDebitsAllowed": false,
"fopOnly": false
}
Fire 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 reconcile those payments as they are received into your fire.com GBP or EUR account.
To set up each Fire Open Payment you first need to create a payment request. This contains the details of the payment such as the amount, destination account, description as well as various other specific fields that you want to associate with the payment. The payment request is represented as a URL with a unique code which can then be incorporated into an eCommerce shopping cart as an alternative form of payment. For example, you can put “Pay by Bank” on your website along with “Pay by Card” and “Pay by PayPal”. It can also be distributed by a variety of means such as by email, SMS, WhatsApp, encoded as a QR code, NFC tag, etc.
Consumers confirm the payment details such as the amount are correct, select their bank and authorise the payment. Payments can be made from all major UK banks.
The funds are settled into your fire.com account, fully reconciled, with your specified fields provided.
There are two implementation options you can use to display payment pages with Fire Open Payments.
The payer is brought through 5 stages to complete the payment:
To implement the hosted Fire Open Payments option you need to do the following:
Create your new API application with the appropriate permissions required in Firework Online, as outlined in the “Authentication” steps. The permissions needed are:
Use the Refresh Token, Client ID and Client Key to create an access token as outlined in the “Authentication” steps.
On your website, create a “Pay by Bank” button alongside your other available payment methods, such as Cards and PayPal.
After the user clicks on “Pay by Bank”, you need to create a new Fire Open Payment request as outlined in the “Create a Fire Open Payment” steps. The Create a Fire Open Payment request endpoint returns a unique code for the payment request.
Create a URL using the code returned in this format: https://payments.fire.com/{code}
and redirect your customer to this page.
fire.com will host all the pages that the customer needs to review and authorise the payment. fire.com will will return the paymentUUID of the successful or failed transaction to the returnUrl that you supplied when creating the Fire Open Payment request. fire.com can also optionally send a “webhook” to your website notifying you of the transaction’s outcome.
Once fire.com responds with the paymentUUID and/or the webhook to your website, you need to call the “Get Payment Details” endpoint to get the details of the transaction. This will let you know whether the transaction was successful or not. You can set up the “Payment Request Payment Authorised” webhook to notify you once the payment is authorised or cancelled.
The funds will be received into your GBP or EUR account. Funding will typically be within 6 business hours.
Once the code is returned the payment can be viewed and paid by going to the following URL: https://payments.fire.com/{code}
Fire 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 reconcile those payments as they are received into your fire.com GBP or EUR account.
To set up each Fire Open Payment you first need to create a payment request. This contains the details of the payment such as the amount, destination account, description as well as various other specific fields that you want to associate with the payment. The payment request is represented as a URL with a unique code which can then be incorporated into an eCommerce shopping cart as an alternative form of payment. For example, you can put “Pay by Bank” on your website along with “Pay by Card” and “Pay by PayPal”. It can also be distributed by a variety of means such as by email, SMS, WhatsApp, encoded as a QR code, NFC tag, etc.
Consumers confirm the payment details such as the amount are correct, select their bank and authorise the payment. Payments can be made from all major UK banks.
The funds are settled into your fire.com account, fully reconciled, with your specified fields provided.
There are two implementation options you can use to display payment pages with Fire Open Payments.
The payer is brought through 5 stages to complete the payment:
To implement the hosted Fire Open Payments option you need to do the following:
Create your new API application with the appropriate permissions required in Firework Online, as outlined in the “Authentication” steps. The permissions needed are:
Use the Refresh Token, Client ID and Client Key to create an access token as outlined in the “Authentication” steps.
On your website, create a “Pay by Bank” button alongside your other available payment methods, such as Cards and PayPal.
After the user clicks on “Pay by Bank”, you need to create a new Fire Open Payment request as outlined in the “Create a Fire Open Payment” steps. The Create a Fire Open Payment request endpoint returns a unique code for the payment request.
Create a URL using the code returned in this format: https://payments.fire.com/{code}
and redirect your customer to this page.
fire.com will host all the pages that the customer needs to review and authorise the payment. fire.com will will return the paymentUUID of the successful or failed transaction to the returnUrl that you supplied when creating the Fire Open Payment request. fire.com can also optionally send a “webhook” to your website notifying you of the transaction’s outcome.
Once fire.com responds with the paymentUUID and/or the webhook to your website, you need to call the “Get Payment Details” endpoint to get the details of the transaction. This will let you know whether the transaction was successful or not. You can set up the “Payment Request Payment Authorised” webhook to notify you once the payment is authorised or cancelled.
The funds will be received into your GBP or EUR account. Funding will typically be within 6 business hours.
Once the code is returned the payment can be viewed and paid by going to the following URL: https://payments.fire.com/{code}
This request creates a new Fire Open Payment Payment. A code is returned that can be shared to your customers as a URL by any channel you wish.
You will need to enable the PERM_BUSINESS_POST_PAYMENT_REQUEST
permission to use this endpoint.
Details of the new payment request
Either EUR
or GBP
, and must correspond to the currency of the account the funds are being lodged into in the icanTo
.
Values are EUR
or GBP
.
The type of Fire Open Payment that was created
Value is OTHER
.
The ican of the account to collect the funds into. Must be one of your fire.com Accounts.
The requested amount to pay. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100).
An internal description of the request.
A public facing description of the request. This will be shown to the user when they tap or scan the request.
The max number of people who can pay this request. Must be set to 1 for the ECOMMERCE_GOODS and ECOMMERCE_SERVICES types.
This is the expiry of the payment request. After this time, the payment cannot be paid.
The merchant return URL where the customer will be re-directed to with the result of the transaction.
For the hosted option, the payer will be asked to fill in these fields but they will not be mandatory. You can choose to collect any of the payer's ADDRESS
, REFERENCE
and/or COMMENT1
. If you choose to collect these fields from the payer, you cannot set 'delivery’, 'variableReference’ or 'comment1’ fields respectively.
For the hosted option, these fields will be madatory for the payer to fill in on the hosted payment page. You can choose to collect any the payer's ADDRESS
, REFERENCE
and/or COMMENT1
. If you choose to collect these fields from the payer, you cannot set 'delivery’, 'variableReference’ or 'comment1’ fields respectively.
These fields will be dispalyed to the payer when using the hosted option. You can choose to display any of ORDER_ID
, PRODUCT_ID
, CUSTOMER_ID
, CUSTOMER_NUMBER
and COMMENT2
to the payer.
curl \
-X POST https://api.fire.com/business/v1/paymentrequests \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"currency":"EUR","type":"OTHER","icanTo":42,"amount":1000,"myRef":"Fees","description":"Gym Fees Oct 2020","maxNumberPayments":1,"expiry":"2020-10-22T07:48:56.460Z","returnUrl":"https://example.com/callback","orderDetails":{"merchantNumber":"1234567","orderId":"6c28a47d-4502-4111","productId":"ZFDAA-1221","customerNumber":"123645","variableReference":"John Doe","comment1":"Additional comments about the transaction","comment2":"Additional comments about the transaction","merchantCustomerIdentification":"08303863544","deliveryAddressLine1":"12 The Street","deliveryAddressLine2":"The Way","deliveryCity":"London","deliveryPostCode":"EC15155","deliveryCountry":"GB"},"collectFields":"ADDRESS|REFERENCE|COMMENT1","mandatoryFields":"ADDRESS|REFERENCE|COMMENT1","additionalFields":"ORDER_ID|PRODUCT_ID|CUSTOMER_ID|CUSTOMER_NUMBER|COMMENT2"}'
{
"currency": "EUR",
"type": "OTHER",
"icanTo": 42,
"amount": 1000,
"myRef": "Fees",
"description": "Gym Fees Oct 2020",
"maxNumberPayments": 1,
"expiry": "2020-10-22T07:48:56.460Z",
"returnUrl": "https://example.com/callback",
"orderDetails": {
"merchantNumber": "1234567",
"orderId": "6c28a47d-4502-4111",
"productId": "ZFDAA-1221",
"customerNumber": "123645",
"variableReference": "John Doe",
"comment1": "Additional comments about the transaction",
"comment2": "Additional comments about the transaction",
"merchantCustomerIdentification": "08303863544",
"deliveryAddressLine1": "12 The Street",
"deliveryAddressLine2": "The Way",
"deliveryCity": "London",
"deliveryPostCode": "EC15155",
"deliveryCountry": "GB"
},
"collectFields": "ADDRESS|REFERENCE|COMMENT1",
"mandatoryFields": "ADDRESS|REFERENCE|COMMENT1",
"additionalFields": "ORDER_ID|PRODUCT_ID|CUSTOMER_ID|CUSTOMER_NUMBER|COMMENT2"
}
{
"code": "1234abcd",
"type": "OTHER"
}
Returns all ASPSPs (Account Servicing Payment Service Provider) / banks. The list can be filtered by currency. You will need to enable the PERM_BUSINESS_GET_ASPSPS
permission to use this endpoint.
This endpoint is only required if you intend to host the “Select ASPSP / bank” page yourself.
The three letter code for the currency - either EUR
or GBP
. Use this to filter the list for banks that can be used to pay in a certain currency.
curl \
-X GET https://api.fire.com/business/v1/aspsps \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 10,
"aspsps": [
{
"aspspUuid": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
"alias": "Demo Bank",
"logoUrl": "https://assets.fire.com/pisp/demo.svg",
"country": {
"code": "GB",
"description": "United Kingdom"
},
"currency": {
"code": "EUR",
"description": "Euro"
},
"dateCreated": "2019-08-22T07:48:56.460Z",
"lastUpdated": "2019-08-22T07:48:56.460Z"
}
]
}
Returns the details of a specific payment.
As the customer goes through the process of making the payment the status of the payment will change.
AWAITING_AUTHORISATION
-This is the initial status of all your payments.AUTHORISED
- This is the status that your payment is set to after the customer has authorised the payment with their ASPSP / bank.AWAITING_MULTI_AUTHORISATION
- Some business accounts such as charities require dual authorisation.NOT_AUTHORISED
- Either your customer clicked on cancel or the payment was rejected by their ASPSP / bank.PENDING
- This is the status that your payment is set to after the customer has authorised the payment with their ASPSP / bank but the bank may want to carry out another check before funding the transaction.PAID
- Funds were received into your fire.com GBP or EUR account from your customer’s ASPSP / bank.You will need to enable the PERM_BUSINESS_GET_PAYMENT
permission to use this endpoint.
curl \
-X GET https://api.fire.com/business/v1/payments/4ADFB67A-0F5B-4A9A-9D74-34437250045C \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"paymentRequestCode": "1234abcd",
"paymentUuid": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
"transactionType": "REFUND_REQUEST",
"status": "AWAITING_AUTHORISATION",
"currency": {
"code": "EUR",
"description": "Euro"
},
"type": "OTHER",
"icanTo": 42,
"amount": 1000,
"myRef": "Fees",
"description": "Gym Fees Oct 2020",
"maxNumberPayments": 1,
"expiry": "2024-10-22T07:48:56.460Z",
"returnUrl": "https://example.com/callback",
"webhookUrl": "https://example.com/webhook",
"orderDetails": {
"merchantNumber": "1234567",
"orderId": "6c28a47d-4502-4111",
"productId": "ZFDAA-1221",
"customerNumber": "123645",
"variableReference": "John Doe",
"comment1": "Additional comments about the transaction",
"comment2": "Additional comments about the transaction",
"merchantCustomerIdentification": "08303863544",
"deliveryAddressLine1": "12 The Street",
"deliveryAddressLine2": "The Way",
"deliveryCity": "London",
"deliveryPostCode": "EC15155",
"deliveryCountry": "GB"
},
"collectFields": "ADDRESS|REFERENCE|COMMENT1",
"mandatoryFields": "ADDRESS|REFERENCE|COMMENT1",
"additionalFields": "ORDER_ID|PRODUCT_ID|CUSTOMER_ID|CUSTOMER_NUMBER|COMMENT2"
}
Manage your API Applications and Webhooks
Details of the new API Application
The ICAN of one of your Fire accounts. Restrict this API Application to a certan account.
Whether or not this API Application can be used
The date that this API Application can no longer be used.
A name for the API Application to help you identify it
Number of approvals required to process a payment in a batch
Number of approvals required to create a payee in a batch
The list of permissions required
curl \
-X POST https://api.fire.com/business/v1/apps \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"ican":42,"enabled":true,"expiry":"2019-08-22T07:48:56.460Z","applicationName":"Batch Processing API","numberOfPaymentApprovalsRequired":1,"numberOfPayeeApprovalsRequired":1,"permissions":["PERM_BUSINESS_POST_PAYMENT_REQUEST","PERM_BUSINESS_GET_ASPSPS"]}'
{
"ican": 42,
"enabled": true,
"expiry": "2019-08-22T07:48:56.460Z",
"applicationName": "Batch Processing API",
"numberOfPaymentApprovalsRequired": 1,
"numberOfPayeeApprovalsRequired": 1,
"permissions": [
"PERM_BUSINESS_POST_PAYMENT_REQUEST",
"PERM_BUSINESS_GET_ASPSPS"
]
}
{
"applicationId": 45345,
"ican": 42,
"enabled": true,
"expiry": "2019-08-22T07:48:56.460Z",
"numberOfPaymentApprovalsRequired": 1,
"numberOfPayeeApprovalsRequired": 1,
"clientId": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
"clientKey": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
"refreshToken": "4ADFB67A-0F5B-4A9A-9D74-34437250045C"
}
While there are many types of transactions, they are all represented by the same JSON object with a different txnType.
Retrieve a list of transactions against an account. Recommended to use the v3 endpoint instead.
curl \
-X GET https://api.fire.com/business/v1/accounts/{ican}/transactions?limit=42&offset=42 \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 1,
"dateRangeTo": 1547744156603,
"transactions": [
{
"txnId": 30157,
"refId": 26774,
"ican": 1951,
"currency": {
"code": "EUR",
"description": "Euro"
},
"amountBeforeCharges": 5000,
"feeAmount": 0,
"taxAmount": 0,
"amountAfterCharges": 5000,
"balance": 8500,
"myRef": "Transfer to main account",
"yourRef": "From John Smith",
"date": "2021-04-13 11:06:32 UTC",
"paymentRequestPublicCode": "1abcdefg",
"card": {
"cardId": 42,
"provider": "string",
"alias": "string",
"maskedPan": "string",
"embossCardName": "string",
"embossBusinessName": "string",
"expiryDate": "2023-05-04T09:42:00+00:00"
},
"type": "WITHDRAWAL",
"dateAcknowledged": "2021-04-13 11:06:32 UTC",
"fxTradeDetails": {
"buyCurrency": "GBP",
"sellCurrency": "EUR",
"fixedSide": "SELL",
"buyAmount": 359,
"sellAmount": 500,
"rate4d": 7180,
"provider": "TCC"
},
"batchItemDetails": {
"batchPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"batchItemPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"batchName": "Payroll 2022-11",
"jobNumber": "2018-01-PR"
},
"directDebitDetails": {
"directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
"mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
"originatorReference": "VODA-123456",
"originatorName": "Vodafone PLC",
"originatorAlias": "Three",
"directDebitReference": "VODA-ABC453-1",
"originatorLogoUrlSmall": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
"originatorLogoUrlLarge": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
"mandateReference": "CRZ-102190123",
"mandateUuid": "28d627c3-1889-44c8-ae59-6f6b20239260"
},
"proprietarySchemeDetails": [
{
"type": "SCT",
"data": "remittanceInfoUnstructured^FIRE440286865OD1|instructionId^O223151336499079"
}
],
"relatedParty": {
"type": "FIRE_ACCOUNT",
"account": {
"id": 42,
"alias": "Main Account",
"bic": "CPAYIE2D",
"iban": "IE54CPAY99119911111111",
"nsc": "232221",
"accountNumber": "11111111"
}
},
"eventUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2"
}
]
}
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.
curl \
-X GET https://api.fire.com/business/v3/accounts/{ican}/transactions \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"links": [
{
"rel": "self",
"href": "The URL of the linked page"
}
],
"content": [
{
"txnId": 30157,
"refId": 26774,
"ican": 1951,
"currency": {
"code": "EUR",
"description": "Euro"
},
"amountBeforeCharges": 5000,
"feeAmount": 0,
"taxAmount": 0,
"amountAfterCharges": 5000,
"balance": 8500,
"myRef": "Transfer to main account",
"yourRef": "From John Smith",
"date": "2021-04-13 11:06:32 UTC",
"paymentRequestPublicCode": "1abcdefg",
"card": {
"cardId": 42,
"provider": "string",
"alias": "string",
"maskedPan": "string",
"embossCardName": "string",
"embossBusinessName": "string",
"expiryDate": "2023-05-04T09:42:00+00:00"
},
"type": "WITHDRAWAL",
"dateAcknowledged": "2021-04-13 11:06:32 UTC",
"fxTradeDetails": {
"buyCurrency": "GBP",
"sellCurrency": "EUR",
"fixedSide": "SELL",
"buyAmount": 359,
"sellAmount": 500,
"rate4d": 7180,
"provider": "TCC"
},
"batchItemDetails": {
"batchPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"batchItemPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"batchName": "Payroll 2022-11",
"jobNumber": "2018-01-PR"
},
"directDebitDetails": {
"directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
"mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
"originatorReference": "VODA-123456",
"originatorName": "Vodafone PLC",
"originatorAlias": "Three",
"directDebitReference": "VODA-ABC453-1",
"originatorLogoUrlSmall": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
"originatorLogoUrlLarge": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
"mandateReference": "CRZ-102190123",
"mandateUuid": "28d627c3-1889-44c8-ae59-6f6b20239260"
},
"proprietarySchemeDetails": [
{
"type": "SCT",
"data": "remittanceInfoUnstructured^FIRE440286865OD1|instructionId^O223151336499079"
}
],
"relatedParty": {
"type": "FIRE_ACCOUNT",
"account": {
"id": 42,
"alias": "Main Account",
"bic": "CPAYIE2D",
"iban": "IE54CPAY99119911111111",
"nsc": "232221",
"accountNumber": "11111111"
}
},
"eventUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2"
}
]
}
Retrieve a filtered list of transactions against an account. Recommended to use the v3 endpoint instead.
dateRangeFrom
- A millisecond epoch time specifying the date range start date.dateRangeTo
- A millisecond epoch time specifying the date range end date.searchKeyword
- Search term to filter by from the reference field (myRef
).transactionTypes
- One or more of the transaction types above. This field can be repeated multiple times to allow for multiple transaction types.offset
- The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will return records 40 to 59.curl \
-X GET https://api.fire.com/business/v1/accounts/{ican}/transactions/filter?dateRangeFrom=42&dateRangeTo=42&searchKeyword=string&transactionTypes=string&offset=42 \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 1,
"dateRangeTo": 1547744156603,
"transactions": [
{
"txnId": 30157,
"refId": 26774,
"ican": 1951,
"currency": {
"code": "EUR",
"description": "Euro"
},
"amountBeforeCharges": 5000,
"feeAmount": 0,
"taxAmount": 0,
"amountAfterCharges": 5000,
"balance": 8500,
"myRef": "Transfer to main account",
"yourRef": "From John Smith",
"date": "2021-04-13 11:06:32 UTC",
"paymentRequestPublicCode": "1abcdefg",
"card": {
"cardId": 42,
"provider": "string",
"alias": "string",
"maskedPan": "string",
"embossCardName": "string",
"embossBusinessName": "string",
"expiryDate": "2023-05-04T09:42:00+00:00"
},
"type": "WITHDRAWAL",
"dateAcknowledged": "2021-04-13 11:06:32 UTC",
"fxTradeDetails": {
"buyCurrency": "GBP",
"sellCurrency": "EUR",
"fixedSide": "SELL",
"buyAmount": 359,
"sellAmount": 500,
"rate4d": 7180,
"provider": "TCC"
},
"batchItemDetails": {
"batchPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"batchItemPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"batchName": "Payroll 2022-11",
"jobNumber": "2018-01-PR"
},
"directDebitDetails": {
"directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
"mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
"originatorReference": "VODA-123456",
"originatorName": "Vodafone PLC",
"originatorAlias": "Three",
"directDebitReference": "VODA-ABC453-1",
"originatorLogoUrlSmall": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
"originatorLogoUrlLarge": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
"mandateReference": "CRZ-102190123",
"mandateUuid": "28d627c3-1889-44c8-ae59-6f6b20239260"
},
"proprietarySchemeDetails": [
{
"type": "SCT",
"data": "remittanceInfoUnstructured^FIRE440286865OD1|instructionId^O223151336499079"
}
],
"relatedParty": {
"type": "FIRE_ACCOUNT",
"account": {
"id": 42,
"alias": "Main Account",
"bic": "CPAYIE2D",
"iban": "IE54CPAY99119911111111",
"nsc": "232221",
"accountNumber": "11111111"
}
},
"eventUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2"
}
]
}
The fire.com api allows businesses to automate direct debit payment actions on their fire.com business accounts.
You can retrieve details of your direct debit payments, direct debit mandates and also take actions on both your direct debit payments and mandates.
Retrieve all direct debit payments associated with a direct debit mandate.
The permision needed to access this endpoint is PERM_BUSINESS_GET_DIRECT_DEBITS
The mandate UUID to retrieve
curl \
-X GET https://api.fire.com/business/v1/directdebits?mandateUuid=1A07774B-1461-4595-BC4B-423B739712AF \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 1,
"directdebits": [
{
"directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
"currency": {
"code": "EUR",
"description": "Euro"
},
"status": "RECIEVED",
"type": "FIRST_COLLECTION",
"mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
"originatorReference": "VODA-123456",
"originatorName": "Vodafone PLC",
"originatorAlias": "Three",
"directDebitReference": "VODA-ABC453-1",
"targetIcan": 42,
"targetPayeeId": 12,
"isDDIC": false,
"amount": 100,
"schemeRejectReason": "eg. Instruction cancelled by payer",
"schemeRejectReasonCode": "for BACS (ARUDD) 0|1|2|3|5|6|7|8|9|A|B",
"lastUpdated": "2016-12-15T22:56:05.937Z",
"dateCreated": "2016-12-15T22:56:05.937Z"
}
]
}
Retrieve all details of a single direct debit collection/payment, whether successful or not.
The permision needed to access this endpoint is PERM_BUSINESS_GET_DIRECT_DEBIT
curl \
-X GET https://api.fire.com/business/v1/directdebits/4ADFB67A-0F5B-4A9A-9D74-34437250045C \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
"currency": {
"code": "EUR",
"description": "Euro"
},
"status": "RECIEVED",
"type": "FIRST_COLLECTION",
"mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
"originatorReference": "VODA-123456",
"originatorName": "Vodafone PLC",
"originatorAlias": "Three",
"directDebitReference": "VODA-ABC453-1",
"targetIcan": 42,
"targetPayeeId": 12,
"isDDIC": false,
"amount": 100,
"schemeRejectReason": "eg. Instruction cancelled by payer",
"schemeRejectReasonCode": "for BACS (ARUDD) 0|1|2|3|5|6|7|8|9|A|B",
"lastUpdated": "2016-12-15T22:56:05.937Z",
"dateCreated": "2016-12-15T22:56:05.937Z"
}
This 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
curl \
-X POST https://api.fire.com/business/v1/directdebits/4ADFB67A-0F5B-4A9A-9D74-34437250045C/reject \
-H "Authorization: Bearer $ACCESS_TOKEN"
The permision needed to access this endpoint is PERM_BUSINESS_GET_MANDATES
curl \
-X GET https://api.fire.com/business/v1/mandates \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 1,
"mandates": [
{
"mandateUuid": "28d627c3-1889-44c8-ae59-6f6b20239260",
"currency": {
"code": "EUR",
"description": "Euro"
},
"status": "RECIEVED",
"originatorReference": "VODA-123456",
"originatorName": "Vodafone PLC",
"originatorAlias": "Vodaphone PLC",
"originatorLogoUrlSmall": "originatorLogoSmall",
"originatorLogoUrlLarge": "originatorLogoLarge",
"mandateReference": "CRZ-102190123",
"alias": "Vodaphone",
"targetIcan": 1,
"numberOfDirectDebitCollected": 2,
"valueOfDirectDebitCollected": 2,
"latestDirectDebitAmount": 2,
"latestDirectDebitDate": "2016-12-15T22:56:05.937Z",
"fireRejectionReason": "ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS",
"schemeCancelReason": "e.g. Instruction cancelled by payer",
"schemeCancelReasonCode": "For BACS (ADDACS) - 0|1|2|3|B|C|D|E|R",
"lastUpdated": "2016-12-15T22:56:05.937Z",
"dateCreated": "2016-12-15T22:56:05.937Z",
"dateCompleted": "2016-12-15T22:56:05.937Z",
"dateCancelled": "2016-12-15T22:56:05.937Z"
}
]
}
Retrieve all details for a direct debit mandate.
The permision needed to access this endpoint is PERM_BUSINESS_GET_MANDATE
curl \
-X GET https://api.fire.com/business/v1/mandates/4ADFB67A-0F5B-4A9A-9D74-34437250045C \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"mandateUuid": "28d627c3-1889-44c8-ae59-6f6b20239260",
"currency": {
"code": "EUR",
"description": "Euro"
},
"status": "RECIEVED",
"originatorReference": "VODA-123456",
"originatorName": "Vodafone PLC",
"originatorAlias": "Vodaphone PLC",
"originatorLogoUrlSmall": "originatorLogoSmall",
"originatorLogoUrlLarge": "originatorLogoLarge",
"mandateReference": "CRZ-102190123",
"alias": "Vodaphone",
"targetIcan": 1,
"numberOfDirectDebitCollected": 2,
"valueOfDirectDebitCollected": 2,
"latestDirectDebitAmount": 2,
"latestDirectDebitDate": "2016-12-15T22:56:05.937Z",
"fireRejectionReason": "ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS",
"schemeCancelReason": "e.g. Instruction cancelled by payer",
"schemeCancelReasonCode": "For BACS (ADDACS) - 0|1|2|3|B|C|D|E|R",
"lastUpdated": "2016-12-15T22:56:05.937Z",
"dateCreated": "2016-12-15T22:56:05.937Z",
"dateCompleted": "2016-12-15T22:56:05.937Z",
"dateCancelled": "2016-12-15T22:56:05.937Z"
}
Update Direct Debit Mandate Alias
The permision needed to access this endpoint is PERM_BUSINESS_PUT_MANDATE
curl \
-X POST https://api.fire.com/business/v1/mandates/4ADFB67A-0F5B-4A9A-9D74-34437250045C \
-H "Authorization: Bearer $ACCESS_TOKEN"
This endpoint allows you to cancel a direct debit mandate.
The permision needed to access this endpoint is PERM_BUSINESS_POST_MANDATE_CANCEL
curl \
-X POST https://api.fire.com/business/v1/mandates/4ADFB67A-0F5B-4A9A-9D74-34437250045C/cancel \
-H "Authorization: Bearer $ACCESS_TOKEN"
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.
The permision needed to access this endpoint is PERM_BUSINESS_POST_MANDATE_ACTIVATE
curl \
-X POST https://api.fire.com/business/v1/mandates/4ADFB67A-0F5B-4A9A-9D74-34437250045C/activate \
-H "Authorization: Bearer $ACCESS_TOKEN"
The 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 only set up the payments in batches. These batches must be approved by an authorised user via the firework mobile app.
The process is as follows:
1.Create a new batch
2.Add payments to the batch
3.Submit the batch for approval
Once the batch is submitted, the authorised users will receive notifications to their firework mobile apps. They can review the contents of the batch and then approve or reject it. If approved, the batch is then processed. You can avail of enhanced security by using Dual Authorisation to verify payments if you wish. Dual Authorisation can be enabled by you when setting up your API application in firework online.
Batch Life Cycle Events
A batch webhook can be specified to receive details of all the payments as they are processed. This webhook receives notifications for every event in the batch lifecycle.
The following events are triggered during a batch:
batch.opened: Contains the details of the batch opened. Checks that the callback URL exists - unless a HTTP 200 response is returned, the callback URL will not be configured.
batch.item-added: Details of the item added to the batch
batch.item-removed: Details of the item removed from the batch
batch.cancelled: Notifies that the batch was cancelled.
batch.submitted: Notifes that the batch was submitted
batch.approved: Notifies that the batch was approved.
batch.rejected: Notifies that the batch was rejected.
batch.failed: Notifies that the batch failed - includes the details of the failure (insufficient funds etc)
batch.completed: Notifies that the batch completed successfully. Includes a summary.
Push notifications are sent to the firework mobile app for many of these events too - these can be configured from within the app.
Values are SUBMITTED
, REMOVED
, SUCCEEDED
, or FAILED
.
Values are INTERNAL_TRANSFER
, BANK_TRANSFER
, or NEW_PAYEE
.
Value is DATE
.
Values are DESC
or ASC
.
curl \
-X GET https://api.fire.com/business/v1/batches \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 1,
"items": [
{
"batchItemUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"status": "SUCCEEDED",
"result": {
"code": 500001,
"message": "SUCCESS"
},
"dateCreated": "2021-04-04T10:48:53.540Z",
"lastUpdated": "2021-04-04T10:48:53.540Z",
"feeAmount": 0,
"taxAmount": 0,
"amountAfterCharges": 10000,
"icanFrom": 2150,
"icanTo": 1002,
"amount": 10000,
"ref": "Testing a transfer via batch",
"refId": 123782
}
]
}
The 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 only set up the payments in batches. These batches must be approved by an authorised user via the firework mobile app.
The process is as follows:
1.Create a new batch
2.Add payments to the batch
3.Submit the batch for approval
Once the batch is submitted, the authorised users will receive notifications to their firework mobile apps. They can review the contents of the batch and then approve or reject it. If approved, the batch is then processed. You can avail of enhanced security by using Dual Authorisation to verify payments if you wish. Dual Authorisation can be enabled by you when setting up your API application in firework online.
Batch Life Cycle Events
A batch webhook can be specified to receive details of all the payments as they are processed. This webhook receives notifications for every event in the batch lifecycle.
The following events are triggered during a batch:
batch.opened: Contains the details of the batch opened. Checks that the callback URL exists - unless a HTTP 200 response is returned, the callback URL will not be configured.
batch.item-added: Details of the item added to the batch
batch.item-removed: Details of the item removed from the batch
batch.cancelled: Notifies that the batch was cancelled.
batch.submitted: Notifes that the batch was submitted
batch.approved: Notifies that the batch was approved.
batch.rejected: Notifies that the batch was rejected.
batch.failed: Notifies that the batch failed - includes the details of the failure (insufficient funds etc)
batch.completed: Notifies that the batch completed successfully. Includes a summary.
Push notifications are sent to the firework mobile app for many of these events too - these can be configured from within the app.
This is the first step in creating a batch payment.
Details of the batch payment
The type of the batch - can be one of the listed 3
Values are BANK_TRANSFER
or INTERNAL_TRANSFER
.
GBP or EUR
An optional name you give to the batch at creation time.
An optional job number you can give to the batch to help link it to your own system.
An optional POST URL that all events for this batch will be sent to.
curl \
-X POST https://api.fire.com/business/v1/batches \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"type":"BANK_TRANSFER","currency":"EUR","batchName":"January 2018 Payroll","jobNumber":"2022-01-PR","callbackUrl":"https://my.webserver.com/cb/payroll"}'
{
"type": "BANK_TRANSFER",
"currency": "EUR",
"batchName": "January 2018 Payroll",
"jobNumber": "2022-01-PR",
"callbackUrl": "https://my.webserver.com/cb/payroll"
}
{
"batchUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019"
}
Returns a paginated list of items in the specified batch.
curl \
-X GET https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C/internaltransfers \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 1,
"items": [
{
"batchItemUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"status": "SUCCEEDED",
"result": {
"code": 500001,
"message": "SUCCESS"
},
"dateCreated": "2021-04-04T10:48:53.540Z",
"lastUpdated": "2021-04-04T10:48:53.540Z",
"feeAmount": 0,
"taxAmount": 0,
"amountAfterCharges": 10000,
"icanFrom": 2150,
"icanTo": 1002,
"amount": 10000,
"ref": "Testing a transfer via batch",
"refId": 123782
}
]
}
Simply specify the source account, destination account, amount and a reference.
Details of the source account, destination account, amount and a reference.
curl \
-X POST https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C/internaltransfers \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"icanFrom":2001,"icanTo":3221,"amount":10000,"ref":"Moving funds to Operating Account"}'
{
"icanFrom": 2001,
"icanTo": 3221,
"amount": 10000,
"ref": "Moving funds to Operating Account"
}
{
"batchItemUuid": "fba4a76a-ce51-4fc1-b562-98ec01299e4d"
}
Returns a paginated list of items in the specified batch.
curl \
-X GET https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C/banktransfers \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 1,
"items": [
{
"batchItemUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"status": "SUCCEEDED",
"result": {
"code": 500001,
"message": "SUCCESS"
},
"dateCreated": "2021-04-04T10:48:53.540Z",
"lastUpdated": "2021-04-04T10:48:53.540Z",
"feeAmount": 0,
"taxAmount": 0,
"amountAfterCharges": 10000,
"icanFrom": 2150,
"icanTo": 1002,
"amount": 10000,
"ref": "Testing a transfer via batch",
"refId": 123782
}
]
}
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.
Details of Mode 1 & Mode 2.
curl \
-X POST https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C/banktransfers \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"icanFrom":2001,"payeeType":"ACCOUNT_DETAILS","destIban":"IE00AIBK93123412341234","destNsc":"123456","destAccountNumber":"12345678","destAccountHolderName":"John Smith","amount":500,"myRef":"Payment to John Smith for Consultancy in device.","yourRef":"ACME LTD - INV 23434"}'
{
"icanFrom": 2001,
"payeeType": "ACCOUNT_DETAILS",
"destIban": "IE00AIBK93123412341234",
"destNsc": "123456",
"destAccountNumber": "12345678",
"destAccountHolderName": "John Smith",
"amount": 500,
"myRef": "Payment to John Smith for Consultancy in device.",
"yourRef": "ACME LTD - INV 23434"
}
{
"icanFrom": 2001,
"payeeId": 15002,
"payeeType": "PAYEE_ID",
"amount": 500,
"myRef": "Payment to John Smith for Consultancy in device.",
"yourRef": "ACME LTD - INV 23434"
}
{
"batchItemUuid": "fba4a76a-ce51-4fc1-b562-98ec01299e4d"
}
Removes 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).
curl \
-X DELETE https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C/internaltransfers/4ADFB67A-0F5B-4A9A-9D74-34437250045C \
-H "Authorization: Bearer $ACCESS_TOKEN"
Removes 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).
curl \
-X DELETE https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C/banktransfers/{itemUuid} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Returns the details of the batch specified in the API endpoint - {batchUuid}.
curl \
-X GET https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"batchUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"type": "INTERNAL_TRANSFER",
"status": "COMPLETE",
"sourceName": "Payment API",
"batchName": "January 2018 Payroll",
"jobNumber": "2018-01-PR",
"callbackUrl": "https://my.webserver.com/cb/payroll",
"currency": "EUR",
"numberOfItemsSubmitted": 1,
"valueOfItemsSubmitted": 10000,
"numberOfItemsFailed": 0,
"valueOfItemsFailed": 0,
"numberOfItemsSucceeded": 1,
"valueOfItemsSucceeded": 10000,
"lastUpdated": "2021-04-04T10:48:53.540Z",
"dateCreated": "2021-04-04T10:48:53.540Z"
}
Submits 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. If this is a BANK_TRANSFER batch, this will trigger requests for approval to the firework mobile apps of authorised users. Once those users approve the batch, it is queued for processing.
You can only submit a batch while it is in the OPEN state.
curl \
-X PUT https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C \
-H "Authorization: Bearer $ACCESS_TOKEN"
Cancels the Batch. You can only cancel a batch before it is submitted for approval (while it is in the OPEN state).
curl \
-X DELETE https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C \
-H "Authorization: Bearer $ACCESS_TOKEN"
Returns a list of approvers for this batch.
curl \
-X GET https://api.fire.com/business/v1/batches/4ADFB67A-0F5B-4A9A-9D74-34437250045C/approvals \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"approvals": [
{
"userId": 3138,
"emailAddress": "jane.doe@example.com",
"firstName": "Jane",
"lastName": "Doe",
"mobileNumber": 353871234567,
"status": "PENDING_APPROVAL",
"lastUpdated": "2021-04-04T10:48:53.540Z"
}
]
}
curl \
-X GET https://api.fire.com/business/v1/cards \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"cards": [
{
"blocked": false,
"cardId": 51,
"dateCreated": "2017-01-19T16:38:15.803Z",
"emailAddress": "user@example.com",
"expiryDate": "2019-01-31T00:00:00.000Z",
"firstName": "John",
"lastName": "Doe",
"eurIcan": 2150,
"gbpIcan": 2152,
"maskedPan": "537455******1111",
"provider": "MASTERCARD",
"status": "LIVE",
"statusReason": "LOST_CARD",
"userId": 3138
}
]
}
You can create multiple debit cards which can be linked to your fire.com accounts.
Details of the new card
Values are HOME
or BUSINESS
.
curl \
-X POST https://api.fire.com/business/v1/cards \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"userId":3245,"cardPin":5345,"eurIcan":2150,"gbpIcan":2152,"addressType":"BUSINESS","acceptFeesAndCharges":true}'
{
"userId": 3245,
"cardPin": 5345,
"eurIcan": 2150,
"gbpIcan": 2152,
"addressType": "BUSINESS",
"acceptFeesAndCharges": true
}
{
"cardId": 51,
"maskedPan": "537455******1111",
"expiryDate": "2019-01-31T00:00:00.000Z",
"status": "CREATED_ACTIVE"
}
Returns a list of cards transactions related to your fire.com card.
curl \
-X GET https://api.fire.com/business/v1/cards/{cardId}/transactions \
-H "Authorization: Bearer $ACCESS_TOKEN"
[
{
"total": 1,
"dateRangeTo": 1547744156603,
"transactions": [
{
"txnId": 30157,
"refId": 26774,
"ican": 1951,
"currency": {
"code": "EUR",
"description": "Euro"
},
"amountBeforeCharges": 5000,
"feeAmount": 0,
"taxAmount": 0,
"amountAfterCharges": 5000,
"balance": 8500,
"myRef": "Transfer to main account",
"yourRef": "From John Smith",
"date": "2021-04-13 11:06:32 UTC",
"paymentRequestPublicCode": "1abcdefg",
"card": {
"cardId": 42,
"provider": "string",
"alias": "string",
"maskedPan": "string",
"embossCardName": "string",
"embossBusinessName": "string",
"expiryDate": "2023-05-04T09:42:00+00:00"
},
"type": "WITHDRAWAL",
"dateAcknowledged": "2021-04-13 11:06:32 UTC",
"fxTradeDetails": {
"buyCurrency": "GBP",
"sellCurrency": "EUR",
"fixedSide": "SELL",
"buyAmount": 359,
"sellAmount": 500,
"rate4d": 7180,
"provider": "TCC"
},
"batchItemDetails": {
"batchPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"batchItemPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
"batchName": "Payroll 2022-11",
"jobNumber": "2018-01-PR"
},
"directDebitDetails": {
"directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
"mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
"originatorReference": "VODA-123456",
"originatorName": "Vodafone PLC",
"originatorAlias": "Three",
"directDebitReference": "VODA-ABC453-1",
"originatorLogoUrlSmall": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
"originatorLogoUrlLarge": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
"mandateReference": "CRZ-102190123",
"mandateUuid": "28d627c3-1889-44c8-ae59-6f6b20239260"
},
"proprietarySchemeDetails": [
{
"type": "SCT",
"data": "remittanceInfoUnstructured^FIRE440286865OD1|instructionId^O223151336499079"
}
],
"relatedParty": {
"type": "FIRE_ACCOUNT",
"account": {
"id": 42,
"alias": "Main Account",
"bic": "CPAYIE2D",
"iban": "IE54CPAY99119911111111",
"nsc": "232221",
"accountNumber": "11111111"
}
},
"eventUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2"
}
]
}
]
Updates status of an existing card to block which prevents any transactions being carried out with that card.
curl \
-X POST https://api.fire.com/business/v1/cards/{cardId}/block \
-H "Authorization: Bearer $ACCESS_TOKEN"
Updates status of an existing card to unblock which means that transactions can be carried out with that card.
curl \
-X POST https://api.fire.com/business/v1/cards/{cardId}/unblock \
-H "Authorization: Bearer $ACCESS_TOKEN"
You can retrieve the details of all fire.com users on your acount.
curl \
-X GET https://api.fire.com/business/v1/users \
-H "Authorization: Bearer $ACCESS_TOKEN"
[
{
"id": 14059,
"emailAddress": "user@example.com",
"firstName": "Colm",
"lastName": "User",
"mobileNumber": "+353871234567",
"role": "ADMIN",
"status": "LIVE",
"lastlogin": "2012-01-20T11:21:35.000Z",
"userCvl": "FULL",
"mobileApplicationDetails": {
"businessUserId": "14059",
"mobileApplicationId": "18967",
"clientID": "EBB10F29-A653-4DBA-9C8C-BA79F72F78B0",
"status": "LIVE",
"deviceName": "iPhone",
"OS": "Android",
"deviceOSVersion": "14.4"
}
}
]
You can retrieve the details of a specific fire.com user
curl \
-X GET https://api.fire.com/business/v1/user/14059 \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": 14059,
"emailAddress": "user@example.com",
"firstName": "Colm",
"lastName": "User",
"mobileNumber": "+353871234567",
"role": "ADMIN",
"status": "LIVE",
"lastlogin": "2012-01-20T11:21:35.000Z",
"userCvl": "FULL",
"mobileApplicationDetails": {
"businessUserId": "14059",
"mobileApplicationId": "18967",
"clientID": "EBB10F29-A653-4DBA-9C8C-BA79F72F78B0",
"status": "LIVE",
"deviceName": "iPhone",
"OS": "Android",
"deviceOSVersion": "14.4"
}
}
Returns all your payee bank accounts.
Ordered by payee name ascending.
Can be paginated.
curl \
-X GET https://api.fire.com/business/v1/payees \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"total": 1,
"fundingSources": [
{
"id": 742,
"currency": {
"code": "EUR",
"description": "Euro"
},
"status": "LIVE",
"accountName": "Joe",
"accountHolderName": "Joe Bloggs",
"bic": "BOFIIE2DXXX",
"iban": "IE86BOFI90535211111111",
"nsc": "998822",
"accountNumber": "12345678",
"createdBy": "CUSTOMER",
"dateCreated": "2019-08-22T07:48:56.460Z"
}
]
}