openapi: 3.1.0 info: title: Fire Financial Services Business API description: > The fire.com API allows you to deeply integrate Business Account features into your application or back-office systems. version: '1.0' contact: name: Fire API url: 'https://docs.fire.com' email: api@fire.com servers: - url: 'https://api.fire.com/business' description: Production Server paths: /v1/apps/accesstokens: post: summary: Authenticate with the API. description: >- 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. tags: - Authentication operationId: authenticate security: [] requestBody: required: true description: Authentication data content: application/json: schema: $ref: '#/components/schemas/AuthenticationData' responses: '201': description: Access token created content: application/json: schema: $ref: '#/components/schemas/AccessToken' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/accounts: get: summary: List accounts description: >- 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. tags: - Accounts operationId: getAccounts responses: '200': description: An array of account objects. content: application/json: schema: title: accounts type: object properties: accounts: type: array items: $ref: '#/components/schemas/Account' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' post: summary: Create a new Fire Account. description: > 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.** tags: - Accounts operationId: addAccount requestBody: required: true description: Details of the new account content: application/json: schema: $ref: '#/components/schemas/NewAccount' responses: '201': description: The details of the new account content: application/json: schema: $ref: '#/components/schemas/Account' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v2/accounts: get: summary: List accounts (V2) description: >- 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. tags: - Accounts operationId: getAccountsV2 responses: '200': description: An array of account objects. content: application/json: schema: title: accountsV2 type: object properties: activities: type: array items: $ref: '#/components/schemas/AccountV2' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v2/accounts/{ican}': get: summary: Get details of an account (V2) description: >- 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. tags: - Accounts operationId: getAccountByIdV2 parameters: - in: path name: ican schema: type: integer format: int64 description: The ican of the account to retrieve required: true responses: '200': description: An account information object. content: application/json: schema: $ref: '#/components/schemas/AccountV2' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' put: summary: Update account configuration description: >- This endpoint changes the name associated with an account. You will need to enable PERM_BUSINESS_PUT_ACCOUNT to use this endpoint. tags: - Accounts operationId: updateAccountConfig parameters: - in: path required: true name: ican schema: type: string description: The unique id for the account example: '12345' requestBody: required: true description: The name the account name should be changed to content: application/json: schema: $ref: '#/components/schemas/AccountConfiguration' responses: '204': description: The account was updated. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v2/accounts/{ican}/internationaldetails': put: summary: Request international account details description: >- This endpoint will request international account details to be added to your Fire account. You will need to enable PERM_BUSINESS_PUT_ACCOUNT_INTERNATIONALDETAILS to use this endpoint. Please note this feature is currently in pilot testing, and therefore only available to certain customers. tags: - Accounts operationId: requestInternationalDetails parameters: - in: path name: ican schema: type: integer format: int64 description: The ican of the account to retrieve required: true responses: '204': description: >- No body is returned - “Status 204 No Content” signifies the call was successful. You will need to call 'Get details of an account' to view your international account details. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v2/activities: get: summary: Get activity description: >- 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. tags: - Accounts operationId: getActivities responses: '200': description: An array of activity objects. content: application/json: schema: title: activities type: object properties: activities: type: array items: $ref: '#/components/schemas/Activity' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v1/accounts/{ican}': get: summary: Get details of an account description: >- 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. tags: - Accounts operationId: getAccountById parameters: - in: path name: ican schema: type: integer format: int64 description: The ican of the account to retrieve required: true responses: '200': description: An account object. content: application/json: schema: $ref: '#/components/schemas/Account' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v3/accounts/{ican}/transactions': get: summary: List transactions for an account description: > 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. tags: - Transactions operationId: getTransactionsByAccountIdv3 parameters: - in: path name: ican schema: type: integer format: int64 description: The ican of the account to retrieve required: true - in: query name: limit schema: type: integer format: int64 description: The number of records to return. Defaults to 10 - max is 200. required: false - in: query name: dateRangeFrom schema: type: integer format: int64 description: A millisecond epoch time specifying the date range start date. required: false - in: query name: dateRangeTo schema: type: integer format: int64 description: A millisecond epoch time specifying the date range end date. required: false - in: query name: startAfter schema: type: string description: >- A pointer to the position in the resultset to start from. Used when paging through results using the linked pages. required: false responses: '200': description: >- An array of transaction objects for the account with a count (`total`). content: application/json: schema: title: transactions type: object properties: links: type: array items: type: object properties: rel: type: string example: self description: >- The relationship of this link to the current object - self, next, prev page. href: type: string example: >- https://api.fire.com/business/v3/accounts/1/transactions?startAfter=eyJpY2F description: The URL of the linked page content: type: array items: $ref: '#/components/schemas/Transaction' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV3' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV3' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV3' /v1/cards: get: summary: List debit cards description: >- 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. tags: - Debit Cards operationId: getListofCards responses: '200': description: Successful response content: application/json: schema: title: cards type: object properties: cards: type: array items: $ref: '#/components/schemas/Card' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' post: summary: Create a new Fire debit card description: >- 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. tags: - Debit Cards operationId: createNewCard requestBody: required: true description: Details of the new card content: application/json: schema: $ref: '#/components/schemas/NewCard' responses: '200': description: Card created successfully content: application/json: schema: $ref: '#/components/schemas/NewCardResponse' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/me/cards/{cardId}/transactions': get: summary: Get a list of debit card transactions description: >- 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. tags: - Debit Cards operationId: getListofCardTransactions parameters: - in: path name: cardId schema: type: integer format: int64 description: The cardid of the card to retrieve the associated transactions required: true - in: query name: limit schema: type: integer format: int64 description: The number of records to return required: false - in: query name: offset schema: type: integer format: int64 description: The page of records to return required: false responses: '200': description: Successful response content: application/json: schema: type: array items: title: transactionsv1 type: object properties: total: type: integer format: int64 example: 1 description: The total number of card transactions in the list. dateRangeTo: type: integer format: int64 example: 1547744156603 description: milisecond timestamp of date range to value. transactions: type: array items: $ref: '#/components/schemas/Transaction' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/me/cards/{cardId}/block': post: summary: Block a Fire debit card description: >- 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. tags: - Debit Cards operationId: blockCard parameters: - in: path name: cardId schema: type: integer format: int64 description: The cardid of the card to block required: true responses: '204': description: >- No body is returned - “Status 204 No Content” signifies the call was successful. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/me/cards/{cardId}/unblock': post: summary: Unblock a Fire debit card description: >- This endpoint updates status of an existing card to unblock which means that transactions can be carried out with that card. You will need to enable PERM_BUSINESS_POST_MY_CARD_UNBLOCK to use this endpoint. tags: - Debit Cards operationId: unblockCard parameters: - in: path name: cardId schema: type: integer format: int64 description: The cardid of the card to unblock required: true responses: '204': description: >- No body is returned - “Status 204 No Content” signifies the call was successful. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/paymentrequests: post: summary: Create a payment request description: > This endpoint creates a new Open Banking Payment request. A code is returned that can be shared to your customers as a URL by any channel you wish. See our [Guide to Fire Open Payments](/docs/fire-open-payments) for more details. You will need to enable PERM_BUSINESS_POST_PAYMENT_REQUEST to use this endpoint. tags: - Open Banking operationId: newPaymentRequest requestBody: required: true description: Details of the new payment request content: application/json: schema: $ref: '#/components/schemas/NewPaymentRequest' responses: '201': description: Payment Request created successfully content: application/json: schema: $ref: '#/components/schemas/PaymentRequestResponse' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/paymentrequests/{paymentRequestCode}': get: summary: Get payment request details description: > 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. tags: - Open Banking operationId: getPaymentRequestDetails parameters: - in: path required: true name: paymentRequestCode schema: type: string description: The unique 8-character code identifying the payment request. example: 1234abcd responses: '200': description: The Payment Request details object content: application/json: schema: $ref: '#/components/schemas/PaymentRequest' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v2/paymentrequests/{paymentRequestCode}/payments': get: summary: Get list of all payment attempts related to a payment request description: > 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. tags: - Open Banking operationId: getPaymentRequestPaymentsv2 parameters: - in: path required: true name: paymentRequestCode schema: type: string description: The unique 8-character code identifying the payment request. example: 1234abcd responses: '200': description: The Payment Request Payments content: application/json: schema: $ref: '#/components/schemas/PaymentRequestPayment' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v2/paymentrequests/{paymentRequestCode}/reports': get: summary: Get a report from a payment request description: > 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. tags: - Open Banking operationId: getPaymentRequestReportV2 parameters: - in: path required: true name: paymentRequestCode schema: type: string description: The unique 8-character code identifying the payment request. example: 1234abcd responses: '200': description: The Payment Request Report content: application/json: schema: $ref: '#/components/schemas/PaymentRequestReport' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' /v2/paymentrequests/sent: get: summary: Get a list of payment request transactions description: > 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. tags: - Open Banking operationId: getPaymentRequestsSentV2 responses: '200': description: The list of payment requests sent content: application/json: schema: $ref: '#/components/schemas/PaymentRequestsSent' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v2/paymentrequests/{paymentRequestCode}/public': get: summary: List details of a public payment request description: >- This endpoint returns an object of payment request information. You will need to enable PERM_BUSINESS_GET_PUBLIC_PAYMENT_REQUEST to use this endpoint. tags: - Open Banking operationId: getPublicPaymentRequest parameters: - in: path required: true name: paymentRequestCode schema: type: string description: The unique 8-character code identifying the payment request. example: 1234abcd responses: '200': description: The Payment Request Information content: application/json: schema: $ref: '#/components/schemas/PublicPaymentRequest' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' /v2/fx/rate: get: summary: Get FX rates description: >- This endpoint returns the exchange rate between two currencies. You will need to enable PERM_BUSINESS_GET_FX_RATE to use this endpoint. tags: - FX operationId: getFXRates parameters: - in: query required: true name: sellCurrency schema: type: string description: The currency the money is currently in - in: query required: true name: buyCurrency schema: type: string description: The currency the money is being converted to responses: '200': description: An object of FX information content: application/json: schema: $ref: '#/components/schemas/FxRate' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' /v2/limits: get: summary: List all limits description: >- This endpoint returns an array of limit information. You will need to enable PERM_BUSINESS_GET_LIMITS to use this endpoint. tags: - Profile Management operationId: getLimits responses: '200': description: An object of limit information content: application/json: schema: $ref: '#/components/schemas/Limit' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v2/webhooks/{webhookId}/events/{event}/test': get: summary: Send test webhooks description: >- This endpoint sends a test webhook response for a selected event to the chosen URL. You will need to enable PERM_BUSINESS_GET_WEBHOOK_EVENT_TEST to use this endpoint. tags: - API and Webhooks operationId: sendTestWebhook parameters: - in: path required: true name: webhookId schema: type: integer format: int64 description: The ID of the webhook to test example: 32 - in: path required: true name: event schema: type: string enum: - LODGEMENT_RECEIVED - PAYMENT_RECEIVED - PAYMENT_REQUEST_PAYMENT_RECEIVED - ACCOUNT_CREATED - CARD_CREATED - CARD_AUTHORISATION - CARD_SETTLEMENT - PAYMENT_REQUEST_PAYMENT_AUTHORISED - PIS_LODGEMENT_RECEIVED description: >- The type of event to send. Currently only one event type is associated with each webhook, however this may change in future. example: CARD_AUTHORISATION responses: '200': description: Webhook test sent. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' /v2/webhooks: get: summary: List all webhooks description: >- This endpoint lists all webhooks on your Fire account. You will need to enable PERM_BUSINESS_GET_WEBHOOKS to use this endpoint. tags: - API and Webhooks operationId: getWebhookEvents responses: '200': description: An object of information about your webhooks content: application/json: schema: Title: webhookEvents Type: array items: $ref: '#/components/schemas/WebhookEvent' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v2/batches/{batchUuid}/newpayees': get: summary: List new payees in a batch description: > 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. tags: - Batch Payments operationId: getNewPayeeBatch parameters: - in: path required: true name: batchUuid schema: type: string description: The UUID for the batch example: 2DF456A-1234-5ABC-BAC0-C0CED23544F1 responses: '200': description: New Payee Object content: application/json: schema: $ref: '#/components/schemas/NewPayeesBatch' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v2/payments/{paymentUuid}': get: summary: Get payment details description: > 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. tags: - Open Banking operationId: getPaymentDetailsv2 parameters: - in: path required: true name: paymentUuid schema: type: string description: The unique id for the transaction. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '200': description: The Payment Request details object content: application/json: schema: $ref: '#/components/schemas/PaymentRequestPayment' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' /v1/aspsps: get: summary: Get list of ASPSPs / Banks description: > 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.*** tags: - Open Banking operationId: getListOfAspsps parameters: - in: query name: currency schema: type: string required: false description: >- 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. example: EUR responses: '200': description: | A list of ASPSPs the customers can use to pay a payment. content: application/json: schema: title: aspsps type: object properties: total: type: integer example: 10 description: The total number of ASPSPs in the list. aspsps: type: array items: $ref: '#/components/schemas/Aspsp' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/users: get: summary: List all users description: >- This endpoint will retrieve the details of all Fire users on your acount.You will need to enable PERM_BUSINESS_GET_USERS to use this endpoint. tags: - Profile Management operationId: getUsers responses: '200': description: List of all Users. content: application/json: schema: type: array items: $ref: '#/components/schemas/User' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/users/{userId}': get: summary: Get the details of a user description: >- This endpoint will retrieve the details of a specific Fire user. You will need to enable PERM_BUSINESS_GET_USER to use this endpoint. tags: - Profile Management operationId: getUser parameters: - in: path required: true name: userId schema: type: integer format: int64 description: Lists a specific User example: 14059 responses: '200': description: Unique information about a User. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/apps: get: summary: List all API applications description: >- 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. tags: - API and Webhooks operationId: getApiApplications responses: '200': description: Successful response content: application/json: schema: title: apiApplications type: object properties: applications: type: array items: $ref: '#/components/schemas/Application' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' post: summary: Create an API Application description: >- 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. tags: - API and Webhooks operationId: createApiApplication requestBody: required: true description: Details of the new API Application content: application/json: schema: $ref: '#/components/schemas/NewApiApplication' responses: '201': description: API Application created successfully content: application/json: schema: $ref: '#/components/schemas/AppCreated' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/apps/{applicationId}/permissions': get: summary: List all permissions for an API application description: >- 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. tags: - API and Webhooks operationId: getPermissions parameters: - in: path required: true name: applicationId schema: type: integer format: int64 description: >- The number associated with the app to retrieve the associated permissions responses: '200': description: An array of permission objects. content: application/json: schema: title: apiAppPermissions type: object properties: permissions: type: array items: $ref: '#/components/schemas/Permission' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/apps/permissions: get: summary: List all permissions for API applications description: >- 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. tags: - API and Webhooks operationId: getAllPermissions responses: '200': description: An array of permission objects. content: application/json: schema: title: apiAppPermissions type: object properties: permissions: type: array items: $ref: '#/components/schemas/Permission' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/payees: get: summary: List payees description: > This endpoint will return all payees on your account. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCES to use this endpoint. tags: - Payees operationId: getPayees parameters: - in: query name: limit schema: type: integer format: int64 description: The number of records to return. Defaults to 10 - max is 200. required: false - in: query name: offset schema: type: integer format: int64 description: >- 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. required: false responses: '200': description: An array of Payees content: application/json: schema: title: payees type: object properties: total: type: integer example: 1 description: The total number of payees in the list. fundingSources: type: array items: $ref: '#/components/schemas/Payee' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/payees/{payeeId}': get: summary: Get details of a payee description: > This endpoint will retrieve the details of a specific payee. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCE to use this endpoint. tags: - Payees operationId: getPayeeDetails parameters: - in: path required: true name: payeeId schema: type: integer format: int64 description: The unique ID of the payee. example: 346748 responses: '200': description: An array of payee information content: application/json: schema: $ref: '#/components/schemas/Payee' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/payees/{payeeId}/transactions': get: summary: List transaction for a payee account description: > 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. tags: - Payees operationId: getPayeeTransactions parameters: - in: path required: true name: payeeId schema: type: integer format: int64 description: The unique ID of the payee. example: 346748 responses: '200': description: An array of payee transaction information content: application/json: schema: title: transactionsv1 type: object properties: total: type: integer format: int64 example: 1 description: The total number of card transactions in the list. dateRangeTo: type: integer format: int64 example: 1547744156603 description: milisecond timestamp of date range to value. transactions: type: array items: $ref: '#/components/schemas/Transaction' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/directdebits: get: summary: List all direct debits description: > 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. tags: - Direct Debits operationId: getDirectDebitsForMandateUuid parameters: - in: query name: mandateUuid schema: type: string required: true description: The mandate UUID to retrieve example: 1A07774B-1461-4595-BC4B-423B739712AF responses: '200': description: >- Retrieve all direct debit payments associated with a direct debit mandate. content: application/json: schema: title: directDebits type: object properties: total: type: integer format: int64 description: Number of direct debits found example: 1 directdebits: type: array items: $ref: '#/components/schemas/DirectDebit' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/directdebits/{directDebitUuid}': get: summary: Get the details of a direct debit description: > 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. tags: - Direct Debits operationId: getDirectDebitByUuid parameters: - in: path required: true name: directDebitUuid schema: type: string description: The uuid of the direct debit to retrieve. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '200': description: Retrieve all details of a single direct debit collection/payment content: application/json: schema: $ref: '#/components/schemas/DirectDebit' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/directdebits/{directDebitUuid}/reject': post: summary: Reject a direct debit description: > This endpoint allows you to reject a direct debit payment where the status is still set to RECEIVED. You will need to enable PERM_BUSINESS_POST_DIRECT_DEBIT_REJECT to use this endpoint. tags: - Direct Debits operationId: rejectDirectDebit parameters: - in: path required: true name: directDebitUuid schema: type: string description: The uuid of the direct debit to retrieve. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '204': description: 204 no content '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/mandates: get: summary: List all direct debit mandates description: > This endpoint will list all mandates on your Fire account. You will need to enable PERM_BUSINESS_GET_MANDATES to use this endpoint. tags: - Direct Debits operationId: getDirectDebitMandates responses: '200': description: List all direct debit mandates. content: application/json: schema: title: mandates type: object properties: total: type: integer format: int64 description: Number of direct debits found example: 1 mandates: type: array items: $ref: '#/components/schemas/Mandate' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/mandates/{mandateUuid}': get: summary: Get the details of a direct debit mandate description: > 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. tags: - Direct Debits operationId: getMandate parameters: - in: path required: true name: mandateUuid schema: type: string description: The uuid of the mandate to retrieve. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '200': description: Retrieve all details for a direct debit mandate. content: application/json: schema: $ref: '#/components/schemas/Mandate' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' put: summary: Update direct debit mandate alias description: > This endpoint allows you to update Direct Debit Mandate Alias. You will need to enable PERM_BUSINESS_PUT_MANDATE to use this endpoint. tags: - Direct Debits operationId: updateMandateAlias parameters: - in: path required: true name: mandateUuid schema: type: string description: The uuid of the mandate to update. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C requestBody: required: true description: Alias to update the mandate to content: application/json: schema: $ref: '#/components/schemas/Alias' responses: '204': description: 204 no content '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/mandates/{mandateUuid}/cancel': post: summary: Cancel a direct debit mandate description: > This endpoint allows you to cancel a direct debit mandate. You will need to enable PERM_BUSINESS_POST_MANDATE_CANCEL to use this endpoint. tags: - Direct Debits operationId: cancelMandateByUuid parameters: - in: path required: true name: mandateUuid schema: type: string description: The uuid of the mandate to cancel. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '204': description: 204 no content '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/mandates/{mandateUuid}/activate': post: summary: Activate a direct debit mandate description: > 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. tags: - Direct Debits operationId: activateMandate parameters: - in: path required: true name: mandateUuid schema: type: string description: The uuid of the mandate to activate. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '204': description: 204 no content '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' /v1/batches: post: summary: Create a new batch description: > 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. tags: - Batch Payments operationId: createBatchPayment requestBody: required: true description: Details of the batch payment content: application/json: schema: $ref: '#/components/schemas/NewBatch' responses: '200': description: Batch created successfully content: application/json: schema: $ref: '#/components/schemas/NewBatchResponse' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' get: summary: List all batches description: > 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. tags: - Batch Payments operationId: getBatches parameters: - in: query name: batchTypes schema: type: string enum: - INTERNAL_TRANSFER - BANK_TRANSFER - INTERNATIONAL_TRANSFER - NEW_PAYEE description: The type of the batch. Can be one of the listed enums. example: INTERNAL_TRANSFER - in: query name: orderBy schema: type: string enum: - DATE description: You can order the batches by date. No other options at this time example: DATE - in: query name: order schema: type: string enum: - DESC - ASC description: You can order the batches by ascending or descending order. example: DESC - in: query name: offset schema: type: integer format: int64 description: >- 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. example: '0' - in: query name: limit schema: type: integer format: int64 description: The number of records to return. Defaults to 10 - max is 200. example: '10' responses: '200': description: List all batches. content: application/json: schema: title: batchItems type: object properties: total: type: integer format: int64 example: 1 description: total number of batches returned batchRequests: type: array items: $ref: '#/components/schemas/BatchRequest' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/batches/{batchUuid}/internaltransfers': post: summary: Add an internal transfer to a Batch description: >- 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. tags: - Batch Payments operationId: addInternalTransferBatchPayment parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C requestBody: required: true description: >- Details of the source account, destination account, amount and a reference. content: application/json: schema: title: batchItemInternalTransfer type: object properties: icanFrom: type: integer format: int64 example: 2001 description: >- The account ID for the fire.com account the funds are taken from icanTo: type: integer format: int64 example: 3221 description: >- The account ID for the fire.com account the funds are directed to amount: type: integer format: int64 example: 10000 description: >- The amount of funds to be transferred. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). ref: type: string example: Moving funds to Operating Account description: The reference on the transaction responses: '200': description: >- Batch payment added successfully. Note* Please use batchUuid when submitting a batch, not batchItemUuid. content: application/json: schema: $ref: '#/components/schemas/NewBatchItemResponse' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' get: summary: List items for an internal transfer batch description: >- 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. tags: - Batch Payments operationId: getItemsBatchInternalTrasnfer parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C - in: query name: offset schema: type: integer format: int64 description: >- 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. example: '0' - in: query name: limit schema: type: integer format: int64 description: The number of records to return. Defaults to 10 - max is 200. example: '10' responses: '200': description: >- A fire.com list object of Batch Items (Internal transfers or Bank transfers). content: application/json: schema: title: batchItemsInternationalTransfer type: object properties: total: type: integer format: int64 example: 1 description: total number of batches returned items: type: array items: $ref: '#/components/schemas/BatchItemInternalTransfer' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/batches/{batchUuid}/banktransfers': post: summary: Add a bank transfer to a batch. description: > 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. tags: - Batch Payments operationId: addBankTransferBatchPayment parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C requestBody: required: true description: Details of **Mode 1** & **Mode 2**. content: application/json: schema: oneOf: - $ref: '#/components/schemas/BatchItemBankTransferMode1' - $ref: '#/components/schemas/BatchItemBankTransferMode2' responses: '200': description: >- Batch payment added successfully. **Note*** Please use batchUuid when submitting a batch, not batchItemUuid. content: application/json: schema: $ref: '#/components/schemas/NewBatchItemResponse' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' get: summary: List items for a bank transfer batch description: >- 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. tags: - Batch Payments operationId: getItemsBatchBankTransfer parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C - in: query name: offset schema: type: integer format: int64 description: >- 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. example: '0' - in: query name: limit schema: type: integer format: int64 description: The number of records to return. Defaults to 10 - max is 200. example: '10' responses: '200': description: >- A fire.com list object of Batch Items (Internal transfers or Bank transfers). content: application/json: schema: title: batchItemsBankTRansfer type: object properties: total: type: integer format: int64 example: 1 description: total number of batches returned items: type: array items: $ref: '#/components/schemas/BatchItemBankTransfer' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v2/batches/{batchUuid}/internationaltransfers': post: summary: Add an international transfer to a Batch description: > 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. tags: - Batch Payments operationId: addInternationalTransferBatchPayment parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C requestBody: required: true description: Details of **Mode 1** content: application/json: schema: title: batchItemInternationalTransferMode1 type: object properties: icanFrom: type: integer format: int64 example: 2001 description: >- The Fire account ID for the fire.com account the funds are taken from. payeeId: type: integer format: int64 example: 15002 description: The ID of the existing payee amount: type: integer format: int64 example: 500 description: >- The value of the payment in the beneficiary currency. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). myRef: type: string example: Payment to John Smith for Consultancy in device. description: >- The reference on the transaction for your records - not shown to the beneficiary. yourRef: type: string example: ACME LTD - INV 23434 description: >- The reference on the transaction - displayed on the beneficiary bank statement. paymentReason: type: string example: 'Invoice Payment, Salary/Dividend Payment' description: >- The reason for the payment, used for transaction monitoring purposes. Must be one of Invoice Payment|Salary/Dividend Payment|Expenses|Savings|Other responses: '200': description: >- Batch payment added successfully. **Note*** Please use batchUuid when submitting a batch, not batchItemUuid. content: application/json: schema: $ref: '#/components/schemas/NewBatchItemResponse' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' get: summary: List items for an international transfer batch description: >- Returns a paginated list of items in the specified batch. You will need to enable PERM_BUSINESS_GET_BATCH_INTERNATIONALTRANSFERS to use this endpoint. tags: - Batch Payments operationId: getItemsBatchInternationalTransfer parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C - in: query name: offset schema: type: integer format: int64 description: >- 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. example: '0' - in: query name: limit schema: type: integer format: int64 description: The number of records to return. Defaults to 10 - max is 200. example: '10' responses: '200': description: >- A fire.com list object of Batch Items (Internal transfers, Bank transfers or International transfers). content: application/json: schema: title: batchItemsInternationalTransfer type: object properties: total: type: integer format: int64 example: 1 description: total number of batches returned items: type: array items: $ref: '#/components/schemas/BatchItemInternationalTransfer' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/batches/{batchUuid}/internaltransfers/{itemUuid}': delete: summary: Remove an internal transfer from a batch description: >- 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. tags: - Batch Payments operationId: deleteInternalTransferBatchPayment parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C - in: path required: true name: itemUuid schema: type: string description: The uuid of the item to remove. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '200': description: Batch payment deleted successfully. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/batches/{batchUuid}/banktransfers/{itemUuid}': delete: summary: Remove a bank transfer from a batch. description: >- 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. tags: - Batch Payments operationId: deleteBankTransferBatchPayment parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C - in: path required: true name: itemUuid schema: type: string description: The uuid of the item to remove. responses: '200': description: Batch payment deleted successfully. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v2/batches/{batchUuid}/internationaltransfers/{itemUuid}': delete: summary: Remove an international transfer from a batch description: >- 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. tags: - Batch Payments operationId: deleteInternationalTransferBatchPayment parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C - in: path required: true name: itemUuid schema: type: string description: The uuid of the item to remove. responses: '200': description: Batch payment deleted successfully. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/batches/{batchUuid}': delete: summary: Cancel a batch description: >- 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. tags: - Batch Payments operationId: cancelBatchPayment parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '200': description: Batch payment deleted successfully. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' get: summary: Get the details of a batch description: >- 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. tags: - Batch Payments operationId: getDetailsSingleBatch parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '200': description: >- Returns the details of the batch specified in the API endpoint - {batchUuid}. content: application/json: schema: $ref: '#/components/schemas/Batch' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' put: summary: Submit a batch description: > This endpoint allows you to submit a Batch (for approval in the case of a **BANK_TRANSFER** or **INTERNATIONAL_TRANSFER**). If this is an **INTERNAL_TRANSFER** batch, the transfers are immediately queued for processing. If this is a **BANK_TRANSFER** or **INTERNATIONAL_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. You will need to enable PERM_BUSINESS_PUT_BATCH to use this endpoint. tags: - Batch Payments operationId: submitBatch parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '204': description: >- No body is returned - a HTTP 204 No Content response signifies the call was successful. '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v1/batches/{batchUuid}/approvals': get: summary: List approvals for a batch. description: >- 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. tags: - Batch Payments operationId: getListofApproversForBatch parameters: - in: path required: true name: batchUuid schema: type: string description: The uuid of the batch. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C responses: '200': description: A list of approvers for this batch. content: application/json: schema: $ref: '#/components/schemas/BatchApprover' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' '/v2/users/{userId}/address': get: summary: Get the address of a user description: >- This endpoint will return the address of a specific Fire user. You will need to enable PERM_BUSINESS_GET_USER_ADDRESS to use this endpoint. tags: - Profile Management operationId: getUserAddress parameters: - in: path required: true name: userId schema: type: integer format: int64 description: Lists a specific User example: 14059 responses: '200': description: A user's address content: application/json: schema: $ref: '#/components/schemas/Address' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' /v2/services: get: summary: Get service Fees and info description: >- 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. tags: - Profile Management operationId: getServiceFees responses: '200': description: An object of services information content: application/json: schema: title: businessServices type: array items: $ref: '#/components/schemas/BusinessService' '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '/v2/paymentrequests/{paymentRequestCode}/status': put: summary: Update the status of a payment request description: > This endpoint will update the status of a payment request. The payment request should be active or removed. You will need to enable PERM_BUSINESS_PUT_PAYMENT_REQUEST_STATUS to use this endpoint. tags: - Open Banking operationId: updatePaymentRequest parameters: - in: path required: true name: paymentRequestCode schema: type: string description: The code of the payment request to update example: xyzabcde requestBody: required: true description: The status the payment request should be changed to content: application/json: schema: $ref: '#/components/schemas/Status' responses: '204': description: 204 no content '400': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '401': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' '403': description: >- An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint. content: application/json: schema: title: apiErrors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiErrorV2' webhooks: webhook: post: summary: Event Webhook tags: - Webhooks description: >- Webhooks allow you to be notified of events as they happen on your Fire accounts. The below sample response shows how a webhook from Fire will arrive at your server. See our 'Webhooks' guide for more detailed information. requestBody: required: true content: application/jwt: schema: type: string example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ responses: '200': description: >- A 200 response is required from your server. Returns a 200 response to indicate that the data was received successfully. components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Access Token responses: UnauthorisedError: description: An error has occured parameters: orderParam: name: order in: query required: false description: Either `ASC` or `DESC` schema: enum: - ASC - DESC orderByParam: name: orderBy in: query required: false description: Currently defaults to `DATE` No other options at this time. schema: enum: - DATE limitParam: name: limit in: query required: false description: The number of records to return. Defaults to 10 - max is 200. schema: type: integer default: 10 maximum: 200 offsetParam: name: offset in: query required: false description: >- 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. schema: type: integer default: 0 schemas: Account: title: account type: object properties: ican: type: integer format: int64 description: identifier for the fire.com account (assigned by fire.com) example: 42 name: type: string description: the name the user gives to the account to help them identify it. example: Main Account colour: type: string description: Internal Use deprecated: true example: ORANGE currency: $ref: '#/components/schemas/Currency' balance: type: integer format: int64 description: >- the balance of the account (in minor currency units - pence, cent etc. 434050 == 4,340.50 GBP for a GBP account). example: 23950 status: type: string enum: - LIVE - BREXIT_MIGRATED description: >- Live accounts can be used as normal. Migrated accounts were used before Brexit and are read-only. cbic: type: string example: CPAYIE2D description: the BIC of the account (provided if currency is EUR). ciban: type: string example: IE54CPAY99119911111111 description: the IBAN of the account (provided if currency is EUR). cnsc: type: string example: '232221' description: the Sort Code of the account. ccan: type: string example: '11111111' description: the Account Number of the account. defaultAccount: type: boolean example: true description: >- 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). directDebitsAllowed: type: boolean example: false description: Whether or not direct debits can be set up on this account. fopOnly: type: boolean example: false description: >- Indicates that this account is for collecting Fire Open Payments only. All other payments to this account will be returned. NewAccount: title: newAccount type: object properties: accountName: type: string example: Operating Account description: Name to give the new account maxLength: 50 currency: type: string enum: - EUR - GBP description: The currency of the new account acceptFeesAndCharges: type: boolean description: a field to indicate you accept the fee for a new account Transaction: title: transaction type: object properties: txnId: type: integer format: int64 description: >- The id of this side of the transaction (each transaction has two sides - a to and a from). This is used to get the details of the transaction. example: 30157 refId: type: integer format: int64 description: The id of the transaction. example: 26774 ican: type: integer format: int64 description: >- identifier for the fire.com account (assigned by fire.com) This field is only used in the condensed version. example: 1951 currency: $ref: '#/components/schemas/Currency' amountBeforeCharges: type: integer format: int64 description: Amount of the transaction before the fees and taxes were applied. example: 5000 feeAmount: type: integer format: int64 description: 'The amount of the fee, if any.' example: 0 taxAmount: type: integer format: int64 description: 'The amount of the tax, if any (e.g. Stamp duty for ATM transactions)' example: 0 amountAfterCharges: type: integer format: int64 description: >- Net amount lodged or taken from the account after fees and charges were applied. example: 5000 balance: type: integer format: int64 description: >- the balance of the account (in minor currency units - pence, cent etc. 434050 == 4,340.50 GBP for a GBP account). example: 8500 myRef: type: string description: The comment/reference on the transaction example: Transfer to main account yourRef: type: string description: >- The comment/reference on the transaction that appears on the recipients statement. Only for withdrawals example: From John Smith date: type: string format: date-time description: Date of the transaction example: 2021-04-13T11:06:32.437Z paymentRequestPublicCode: type: string description: >- (FOP payments only) The FOP Payment Code that was used to make this payment. example: 1abcdefg card: $ref: '#/components/schemas/RelatedCard' type: type: string description: "The type of the transaction:\n* `LODGEMENT` - Bank Transfer received\n* `PIS_LODGEMENT` - Fire Open Payments Lodgement received\n* `MANUAL_TRANSFER` - Manual Transfer to\n* `WITHDRAWAL` - Bank Transfer sent\n* `REVERSAL` - Credit Reversal\n* `DIRECT_DEBIT` - A direct debit.\n* `DIRECT_DEBIT_REPRESENTED` - A Direct Debit that was requested again after initially failing.\n* `DIRECT_DEBIT_REFUND` - A refund of a Direct debit.\n* `INTERNAL_TRANSFER_TO` - Internal Transfer sent (between two of my accounts of the same currency)\n* `INTERNAL_TRANSFER_FROM` - Internal Transfer received (between two of my accounts of the same currency)\n* `WITHDRAWAL_RETURNED` - Bank Transfer sent returned\n* `LODGEMENT_REVERSED` - Bank Transfer received returned\n* `FX_INTERNAL_TRANSFER_FROM` - FX Internal Transfer received (between two of my accounts of different currency)\n* `FX_INTERNAL_TRANSFER_TO` - FX Internal Transfer sent (between two of my accounts of different currency)\n* `CREATE_CARD` - The fee taken when a debit card is issued.\n* `ADD_ACCOUNT` - The fee taken when an account is created.\n* `CREATE_ADDITIONAL_USER` - The fee taken when an additional user is created. \n* `CARD_POS_CONTACT_DEBIT` - Card used in store; read by magnetic stripe or pin\n* `CARD_POS_CONTACT_CREDIT` - Card used in store; read by magnetic stripe or pin\n* `CARD_POS_CONTACTLESS_DEBIT` - Card used in store; read by NFC\n* `CARD_POS_CONTACTLESS_CREDIT` - Card used in store; read by NFC\n* `CARD_ECOMMERCE_DEBIT` - Card used on the internet\n* `CARD_ECOMMERCE_CREDIT` - Card used on the internet\n* `CARD_ATM_DEBIT` - Card used in an ATM\n* `CARD_ATM_CREDIT` - Card used in an ATM\n* `CARD_INTERNATIONAL_POS_CONTACT_DEBIT` - Card used in store in non-processing currency; read by magnetic stripe or pin\n* `CARD_INTERNATIONAL_POS_CONTACT_CREDIT` - Card used in store in non-processing currency; read by magnetic stripe or pin\n* `CARD_INTERNATIONAL_POS_CONTACTLESS_DEBIT` - Card used in store in non-processing currency; read by NFC\n* `CARD_INTERNATIONAL_POS_CONTACTLESS_CREDIT` - Card used in store in non-processing currency; read by NFC\n* `CARD_INTERNATIONAL_ECOMMERCE_DEBIT\t` - Card used on the internet in non-processing currency\n* `CARD_INTERNATIONAL_ECOMMERCE_CREDIT` - Card used on the internet in non-processing currency\n* `CARD_INTERNATIONAL_ATM_DEBIT` - Card used in an ATM in non-processing currency\n* `CARD_INTERNATIONAL_ATM_CREDIT` - Card used in an ATM in non-processing currency\n* `CARD_POS_CONTACT_DEBIT_REVERSAL` - Card used in store; read by magnetic stripe or pin - reversed\n* `CARD_POS_CONTACT_CREDIT_REVERSAL` - Card used in store; read by magnetic stripe or pin - reversed\n* `CARD_POS_CONTACTLESS_DEBIT_REVERSAL` - Card used in store; read by NFC - reversed\n* `CARD_POS_CONTACTLESS_CREDIT_REVERSAL` - Card used in store; read by NFC - reversed\n* `CARD_ECOMMERCE_DEBIT_REVERSAL\t` - Card used on the internet - reversed\n* `CARD_ECOMMERCE_CREDIT_REVERSAL` - Card used on the internet - reversed\n* `CARD_ATM_DEBIT_REVERSAL` - Card used in an ATM - reversed\n* `CARD_ATM_CREDIT_REVERSAL` - Card used in an ATM - reversed\n* `CARD_INTERNATIONAL_POS_CONTACT_DEBIT_REVERSAL` - Card used in store in non-processing currency; read by magnetic stripe or pin - reversed\n* `CARD_INTERNATIONAL_POS_CONTACT_CREDIT_REVERSAL` - Card used in store in non-processing currency; read by magnetic stripe or pin - reversed\n* `CARD_INTERNATIONAL_POS_CONTACTLESS_DEBIT_REVERSAL` - Card used in store in non-processing currency; read by NFC - reversed\n* `CARD_INTERNATIONAL_POS_CONTACTLESS_CREDIT_REVERSAL` - One or more of the transaction types above. This field can be repeated multiple times to allow for multiple transaction types.\n* `CARD_INTERNATIONAL_ECOMMERCE_DEBIT_REVERSAL` - Card used in store in non-processing currency; read by NFC - reversed\n* `CARD_INTERNATIONAL_ECOMMERCE_CREDIT_REVERSAL` - Card used in store in non-processing currency; read by NFC - reversed\n* `CARD_INTERNATIONAL_ATM_DEBIT_REVERSAL` - Card used on the internet in non-processing currency - reversed\n* `CARD_INTERNATIONAL_ATM_CREDIT_REVERSAL` - Card used on the internet in non-processing currency - reversed\n" example: WITHDRAWAL dateAcknowledged: type: string format: date-time example: 2021-04-13T11:06:32.437Z fxTradeDetails: $ref: '#/components/schemas/FxTrade' batchItemDetails: $ref: '#/components/schemas/BatchItemDetails' directDebitDetails: $ref: '#/components/schemas/DirectDebitDetails' proprietarySchemeDetails: $ref: '#/components/schemas/ProprietarySchemeDetails' relatedParty: $ref: '#/components/schemas/RelatedParty' eventUuid: type: string description: An internal Fire reference for the transaction (UUID) example: 42de0705-e3f1-44fa-8c41-79973eb80eb2 AccessToken: title: accessToken type: object properties: businessId: type: integer format: int64 description: The business ID for the business. example: 248 apiApplicationId: type: integer format: int64 description: The ID of the application you are using. example: 433 expiry: type: string format: date-time description: The expiry date and time for this token (ISO-8601). example: '2020-10-22T07:48:56.460Z' permissions: type: array items: type: string description: >- The permissions assigned to the Access Token as an array of strings. This provides information on what API access it is allowed. See the section on Scope below. example: - PERM_BUSINESSES_GET_ACCOUNTS - PERM_BUSINESSES_GET_ACCOUNT_TRANSACTIONS accessToken: type: string description: The App Bearer Access Token you can use in further API calls. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C Application: title: apiApplication type: object properties: applicationId: type: integer format: int64 description: This is the ID number of the API application example: 2404 name: type: string description: This is the name given to the API application by the fire.com user example: Account Information Test clientId: type: string description: This is the ID of client associated with the application example: G0919C06D23D-362A-H5D3-E76D8687D6AE refreshToken: type: string description: This is the refresh token associated with the application example: 9C332CF3-1687-4548-8E0E-55E4F0599800 enabled: type: boolean description: This is whether or not the application is enabled for usage numberOfApprovalsRequired: type: integer format: int64 description: >- This is the number of approvals required for any application actions. Only for applications with batch payment permissions enabled. example: 1 numberOfPaymentApprovalsRequired: type: integer format: int64 description: >- This is number of approvals required for any payment batches. Only for applications with batch payment permissions enabled. example: 1 numberOfPayeeApprovalsRequired: type: integer format: int64 description: >- This is the number of approvals required for Payees. Only for applications with batch payment permissions enabled. example: 1 isPayeeCheckEnabled: type: boolean description: >- This is whether or not Verfication of Payee checks are required for SEPA payments before a batch can be submitted. Aspsp: title: aspsp type: object properties: aspspUuid: type: string description: The UUID associated with the ASPSP / bank. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C alias: type: string example: Demo Bank description: The name of the ASPSP / bank. logoUrl: type: string example: 'https://assets.fire.com/pisp/demo.svg' description: A link to the ASPSP / bank's logo in SVG format. country: title: country type: object properties: code: type: string description: 'The 2-letter code for the country - e.g. `IE`, `GP`...' example: GB description: type: string description: The name of the country example: United Kingdom currency: title: currency description: The currency. type: object properties: code: type: string description: The three letter code for the currency. example: EUR description: type: string description: The name of the currency example: Euro dateCreated: type: string format: date-time example: '2019-08-22T07:48:56.460Z' description: The date the ASPSP / bank was created. lastUpdated: type: string format: date-time example: '2019-08-22T07:48:56.460Z' description: The date the ASPSP / bank was last updated. NewBatchItemResponse: title: newBatchItemResponse type: object properties: batchItemUuid: type: string example: fba4a76a-ce51-4fc1-b562-98ec01299e4d description: >- A Batch Item UUID for this item. Note* Do not confuse this for BatchUuid when submitting a batch. ApiError: title: apiError type: object properties: code: type: integer format: int64 description: Error Code example: 50051 message: type: string description: The error message example: 'Sorry, we are unable to proceed with your request.' BatchApprover: title: batchApprovers type: object properties: approvals: type: array items: type: object properties: userId: type: integer format: int64 example: 3138 description: User id assigned by fire.com emailAddress: type: string example: jane.doe@example.com description: User email address firstName: type: string example: Jane lastName: type: string example: Doe mobileNumber: type: string example: 353871234567 status: type: string example: PENDING_APPROVAL lastUpdated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z AuthenticationData: title: authentication type: object properties: clientId: type: string description: The Client ID for this API Application example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C refreshToken: type: string description: The Refresh Token for this API Application example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C nonce: type: integer format: int64 description: >- A random non-repeating number used as a salt for the `clientSecret` below. The simplest nonce is a unix time. example: 728345638475 grantType: type: string enum: - AccessToken description: >- Always `AccessToken`. (This will change to `refresh_token` in a future release.) clientSecret: type: string description: >- 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` ). example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C BatchItemDetails: title: batchItemDetails description: Details of the batch run if this transaction was part of a batch. type: object properties: batchPublicUuid: type: string example: F2AF3F2B-4406-4199-B249-B354F2CC6019 description: The UUID for this batch. batchItemPublicUuid: type: string example: F2AF3F2B-4406-4199-B249-B354F2CC6019 description: The UUID for this item in the batch. batchName: type: string example: Payroll 2022-11 description: The optional name given to the batch at creation time. jobNumber: type: string example: 2018-01-PR description: >- The optional job number given to the batch to link it to your own system. BatchItemBankTransfer: title: batchItem type: object properties: batchItemUuid: type: string example: F2AF3F2B-4406-4199-B249-B354F2CC6019 description: A UUID for this item. status: type: string enum: - Submitted - Removed - Suceeded - Failed result: type: object description: The outcome of the attempted transaction. properties: code: type: integer format: int64 example: 500001 message: type: string example: SUCCESS dateCreated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z lastUpdated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z icanFrom: type: integer format: int64 example: 2150 description: The Fire account ID of the source account. amount: type: integer format: int64 example: 10000 description: The amount of funds to send. In cent or pence myRef: type: string example: Testing a transfer via batch description: The reference on the transaction. yourRef: type: string example: Testing a transfer via batch description: The reference on the transaction. refId: type: integer format: int64 example: 123782 description: >- The ID of the resulting payment in your account. Can be used to retrieve the transaction using the https://api.fire.com/business/v1/accounts/{accountId}/transactions/{refId} endpoint. payeeType: type: string enum: - ACCOUNT_DETAILS - PAYEE_ID description: The type of payee information payeeId: type: integer format: int64 example: 1234567 description: The ID for the named payee destIban: type: string example: IE63CPAYXXXXXXX792562 description: The IBAN for the payee's account destAccountHolderName: type: string example: John Doe description: The payee's name payeeCheckStatus: type: string description: The status of the VoP check for this payee enum: - FULL_MATCH - PARTIAL_MATCH - NO_MATCH - UNABLE_TO_MATCH payeeCheckPartialMatchName: type: string description: >- The result of the VoP check for the payee. Displayed if the VoP result is PARTIAL_MATCH example: John do Batch: title: batch type: object properties: batchUuid: type: string example: F2AF3F2B-4406-4199-B249-B354F2CC6019 description: A UUID for this item. type: type: string enum: - INTERNAL_TRANSFER - BANK_TRANSFER - INTERNATIONAL_TRANSFER - NEW_PAYEE description: The type of the batch - can be one of the listed enums status: type: string enum: - PENDING_APPROVAL - REJECTED - COMPLETE - OPEN - CANCELLED - PENDING_PARENT_BATCH_APPROVAL - READY_FOR_PROCESSING - PROCESSING example: COMPLETE description: status of the batch object sourceName: type: string description: >- A string describing where the batch originated - for instance the name of the API token that was used, or showing that the batch was automatically created by fire.com (in the case of a new payee batch). example: Payment API batchName: type: string example: January 2018 Payroll description: An optional name you give to the batch at creation time jobNumber: type: string example: 2018-01-PR description: >- An optional job number you can give to the batch to help link it to your own system. callbackUrl: type: string example: 'https://my.webserver.com/cb/payroll' description: An optional POST URL that all events for this batch will be sent to. currency: type: string description: All payments in the batch must be the same currency. example: 'EUR, GBP, USD' numberOfItemsSubmitted: type: integer format: int64 description: A count of the number of items in the batch example: 1 valueOfItemsSubmitted: type: integer format: int64 description: >- A sum of the value of items in the batch. Specified in pence or cent. example: 10000 numberOfItemsFailed: type: integer format: int64 description: >- Once processed, a count of the number of items that didn’t process successfully. example: 0 valueOfItemsFailed: type: integer format: int64 description: >- Once processed, a sum of the value of items that didn’t process successfully. Specified in pence or cent. example: 0 numberOfItemsSucceeded: type: integer format: int64 description: >- Once processed, a count of the number of items that processed successfully. example: 1 valueOfItemsSucceeded: type: integer format: int64 description: >- Once processed, a sum of the value of items that processed successfully. Specified in pence or cent. example: 10000 lastUpdated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z dateCreated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z payeeChecks: $ref: '#/components/schemas/PayeeCheck' NewCardResponse: title: newCardResponse type: object properties: cardId: type: integer format: int64 example: 51 maskedPan: type: string example: 537455******1111 expiryDate: type: string format: date-time example: '2019-01-31T00:00:00.000Z' status: type: string enum: - CREATED_ACTIVE - CREATED_INACTIVE example: CREATED_ACTIVE NewCard: title: newCard type: object properties: userId: type: integer format: int64 example: 3245 cardPin: type: string example: 5345 eurIcan: type: integer format: int64 example: 2150 gbpIcan: type: integer format: int64 example: 2152 addressType: type: string enum: - HOME - BUSINESS example: BUSINESS acceptFeesAndCharges: type: boolean example: true Card: title: card type: object properties: blocked: type: boolean description: Whether the card is blocked or not example: false cardId: type: integer format: int64 description: card id assigned by fire.com example: 51 dateCreated: type: string format: date-time description: The date-time the card was created example: '2017-01-19T16:38:15.803Z' emailAddress: type: string description: card user email address example: user@example.com expiryDate: type: string format: date-time description: card expiry date example: '2019-01-31T00:00:00.000Z' firstName: type: string description: card user first name example: John lastName: type: string description: card user last name example: Doe eurIcan: type: integer format: int64 description: identifier for the eur fire.com account (assigned by fire.com) example: 2150 gbpIcan: type: integer format: int64 description: identifier for the gbp fire.com account (assigned by fire.com) example: 2152 maskedPan: type: string description: card number (masked) example: 537455******1111 provider: type: string enum: - MASTERCARD description: card provider example: MASTERCARD status: type: string enum: - LIVE - CREATED_ACTIVE - CREATED_INACTIVE - DEACTIVATED description: card status example: LIVE statusReason: type: string enum: - LOST_CARD - STOLEN_CARD - CARD_DESTROYED description: reason for card status example: LOST_CARD userId: type: integer format: int64 description: card user id assigned by fire.com example: 3138 Country: title: country type: object properties: code: type: string description: 'The 2-letter code for the country - e.g. `IE`, `GP`...' example: GB description: type: string description: The name of the country example: United Kingdom Currency: title: currency description: The currency. type: object properties: code: type: string description: The three letter code for the currency. example: EUR description: type: string description: The name of the currency example: Euro DirectDebitDetails: title: directDebitDetails description: Details of the direct debit (if applicable) type: object properties: directDebitUuid: type: string description: The UUID for the direct debit payment example: 42de0705-e3f1-44fa-8c41-79973eb80eb2 mandateUUid: type: string description: The UUID for the mandate example: f171b143-e3eb-47de-85a6-1c1f1108c701 originatorReference: type: string description: Set by party who sets up the direct debit. example: VODA-123456 originatorName: type: string description: The creator of the party who sets up the direct debit. example: Vodafone PLC originatorAlias: type: string description: The Alias of the party who sets up the direct debit. example: Three directDebitReference: type: string description: The direct debit reference. example: VODA-ABC453-1 originatorLogoUrlSmall: type: string description: >- URL pointing to a small version of the Originator Logo (if available) example: >- https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png originatorLogoUrlLarge: type: string description: >- URL pointing to a large version of the Originator Logo (if available) example: >- https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png mandateReference: type: string example: CRZ-102190123 description: the reference of the mandate mandateUuid: type: string description: The UUID for the mandate example: 28d627c3-1889-44c8-ae59-6f6b20239260 DirectDebit: title: directDebit type: object properties: directDebitUuid: type: string description: The UUID for the direct debit payment example: 42de0705-e3f1-44fa-8c41-79973eb80eb2 currency: $ref: '#/components/schemas/Currency' status: type: string enum: - RECIEVED - REJECT_REQUESTED - REJECT_READY_FOR_PROCESSING - REJECT_RECORD_IN_PROGRESS - REJECT_RECORDED - REJECT_FILE_CREATED - REJECT_FILE_SENT - COLLECTED - REFUND_REQUESTED - REFUND_RECORD_IN_PROGRESS - REFUND_RECORDED - REFUND_FILE_CREATED - REFUND_FILE_SENT description: > The statuses of the direct debit payments associated with the mandate. * 'RECIEVED' - Direct Debit has been recieved * 'REJECT_REQUESTED' - The direct debit has a rejected request associated with it * 'REJECT_READY_FOR_PROCESSING' * 'REJECT_RECORD_IN_PROGRESS' * 'REJECT_RECORDED' * 'REJECT_FILE_CREATED' * 'REJECT_FILE_SENT' * 'COLLECTED' - Direct debit collected * 'REFUND_REQUESTED' - Refund requested on direct debit * 'REFUND_RECORD_IN_PROGRESS' - Refund in progress on direct debit * 'REFUND_RECORDED' * 'REFUND_FILE_CREATED' * 'REFUND_FILE_SENT' example: RECIEVED type: type: string enum: - FIRST_COLLECTION - ONGOING_COLLECTION - REPRESENTED_COLLECTION - FINAL_COLLECTION description: The type of the direct debit. example: FIRST_COLLECTION mandateUUid: type: string description: The UUID for the mandate example: f171b143-e3eb-47de-85a6-1c1f1108c701 originatorReference: type: string description: Set by party who sets up the direct debit. example: VODA-123456 originatorName: type: string description: The creator of the party who sets up the direct debit. example: Vodafone PLC originatorAlias: type: string description: The Alias of the party who sets up the direct debit. example: Three directDebitReference: type: string description: The direct debit reference. example: VODA-ABC453-1 targetIcan: type: integer format: int64 description: The ican of your fire account that the money was taken from example: 42 targetPayeeId: type: integer format: int64 description: The payee that was created when the DD was processed example: 12 isDDIC: type: boolean description: >- DDIC is a Direct Debit Indemnity Claim (i.e.a refund). If if the DD is requested to be refunded it is marked isDDIC true. example: false amount: type: integer format: int64 description: Value of the payment example: 100 schemeRejectReason: type: string description: Reason why rejected example: eg. Instruction cancelled by payer schemeRejectReasonCode: type: string enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - A - B example: for BACS (ARUDD) 0|1|2|3|5|6|7|8|9|A|B description: >- The reject code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason. lastUpdated: type: string format: date-time description: >- Date the direct debit was last updated. Milliseconds since the epoch (1970). example: '2016-12-15T22:56:05.937Z' dateCreated: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: >- Date the direct debit was created. Milliseconds since the epoch (1970). DirectDebitByMandateUUID: title: directDebitByMandateUUID type: object properties: mandateUuid: type: string description: The UUID for the mandate example: 28d627c3-1889-44c8-ae59-6f6b20239260 currency: $ref: '#/components/schemas/Currency' status: type: string enum: - RECIEVED - REJECT_REQUESTED - REJECT_READY_FOR_PROCESSING - REJECT_RECORD_IN_PROGRESS - REJECT_RECORDED - REJECT_FILE_CREATED - REJECT_FILE_SENT - COLLECTED - REFUND_REQUESTED - REFUND_RECORD_IN_PROGRESS - REFUND_RECORDED - REFUND_FILE_CREATED - REFUND_FILE_SENT description: > The statuses of the direct debit payments associated with the mandate. * 'RECIEVED' * 'REJECT_REQUESTED' * 'REJECT_READY_FOR_PROCESSING' * 'REJECT_RECORD_IN_PROGRESS' * 'REJECT_RECORDED' * 'REJECT_FILE_CREATED' * 'REJECT_FILE_SENT' * 'COLLECTED' * 'REFUND_REQUESTED' * 'REFUND_RECORD_IN_PROGRESS' * 'REFUND_RECORDED' * 'REFUND_RECORD_IN_PROGRESS' * 'REFUND_RECORDED' * 'REFUND_FILE_CREATED' * 'REFUND_FILE_SENT' example: RECIEVED originatorReference: type: string description: Set by party who sets up the direct debit. example: VODA-123456 originatorName: type: string description: The creator of the party who sets up the direct debit. example: Vodafone PLC originatorAlias: type: string description: The alias of the party who sets up the direct debit. example: Vodafone PLC Alias originatorLogoUrlSmall: type: string description: Logo url from party who sets up the direct debit. example: originatorLogoSmall originatorLogoUrlLarge: type: string description: Logo url from party who sets up the direct debit. example: originatorLogoLarge mandateReference: type: string example: CRZ-102190123 description: the reference of the mandate alias: type: string example: Vodaphone description: The name of the alias targetIcan: type: integer format: int64 example: 1 description: Identifier for the fire.com account (assigned by fire.com) numberOfDirectDebitCollected: type: integer format: int64 example: 2 description: The number of direct debits collected valueOfDirectDebitCollected: type: integer format: int64 example: 2 description: The value of direct debits collected latestDirectDebitAmount: type: integer format: int64 example: 2 description: The value of largest direct debit collected latestDirectDebitDate: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: The date of latest direct debit collected fireRejectionReason: type: string enum: - ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS - DDIC - ACCOUNT_NOT_FOUND - ACCOUNT_NOT_LIVE - CUSTOMER_NOT_FOUND - BUSINESS_NOT_LIVE - BUSINESS_NOT_FULL - PERSONAL_USER_NOT_LIVE - PERSONAL_USER_NOT_FULL - MANDATE_ALREADY_EXISTS - MANDATE_WITH_DIFERENT_ACCOUNT - NULL_MANDATE_REFERENCE - INVALID_ACCOUNT_CURRENCY - INVALID_MANDATE_REFERENCE - REQUESTED_BY_CUSTOMER_VIA_SUPPORT - CUSTOMER_ACCOUNT_CLOSED - CUSTOMER_DECEASED - ACCOUNT_TRANSFERRED - MANDATE_NOT_FOUND - ACCOUNT_TRANSFERRED_TO_DIFFERENT_ACCOUNT - INVALID_ACCOUNT_TYPE - MANDATE_EXPIRED - MANDATE_CANCELLED - REQUESTED_BY_CUSTOMER description: Rejection reason if transaction is rejected example: ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS schemeRejectReason: type: string description: Reason why rejected example: eg. Instruction cancelled by payer schemeRejectReasonCode: type: string enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - B - C - F - G - H - O - K example: for BACS (ARUDD) 0|1|2|3|5|6|B|C|F|G|H|O|K description: >- The reject code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason. fireCancelReason: type: string enum: - REFRER_TO_CUSTOMER - REQUESTED_BY_CUSTOMER_VIA_SUPPORT - CUSTOMER_DECEASED - CUSTOMER_ACCOUNT_CLOSED - ADVANCE_NOTICE_DISPUTED_VIA_SUPPORT - ACCOUNT_TRANSFERRED - ACCOUNT_TRANSFERRED_TO_DIFFERENT_ACCOUNT - MANDATE_AMENDED - MANDATE_REINSTATED - REQUESTED_BY_CUSTOMER description: Reason why canceled example: REFRER_TO_CUSTOMER schemeCancelReason: type: string description: Reason for cancelation example: e.g. Instruction cancelled by payer schemeCancelReasonCode: type: string example: For BACS (ADDACS) - 0|1|2|3|B|C|D|E|R description: >- The cancelation code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason. lastUpdated: type: string format: date-time description: >- Date the direct debit was last updated. Milliseconds since the epoch (1970). example: '2016-12-15T22:56:05.937Z' dateCreated: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: >- Date the direct debit was created. Milliseconds since the epoch (1970). dateRejected: type: string format: date-time description: >- Date the direct debit was rejected. Milliseconds since the epoch (1970). example: '2016-12-15T22:56:05.937Z' dateCompleted: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: >- Date the direct debit was completed. Milliseconds since the epoch (1970). dateCancelled: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: >- Date the direct debit was canceled. Milliseconds since the epoch (1970). FxTrade: title: fxTrade description: Details of the FX trade (if applicable) type: object properties: buyCurrency: type: string description: currency which is being bought example: GBP sellCurrency: type: string example: EUR description: currency which is being sold fixedSide: type: string description: type of trade - BUY or SELL example: SELL buyAmount: type: integer format: int64 description: amount of buyCurrency being bought example: 359 sellAmount: type: integer format: int64 description: amount of sellCurrency being sold example: 500 rate4d: type: integer format: int64 description: exchange rate example: 7180 provider: type: string example: TCC description: The FX provider used to make the trade. InternalTransferBatchItem: title: batchItemInternalTransfer type: object properties: icanFrom: type: integer format: int64 example: 2001 description: The account ID for the fire.com account the funds are taken from icanTo: type: integer format: int64 example: 3221 description: The account ID for the fire.com account the funds are directed to amount: type: integer format: int64 example: 10000 description: >- The amount of funds to be transferred. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). ref: type: string example: Moving funds to Operating Account description: The reference on the transaction InternationalTransferBatchItem: title: batchItemInternationalTransferMode1 type: object properties: icanFrom: type: integer format: int64 example: 2001 description: >- The Fire account ID for the fire.com account the funds are taken from. payeeId: type: integer format: int64 example: 15002 description: The ID of the existing payee amount: type: integer format: int64 example: 500 description: >- The value of the payment in the beneficiary currency. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). myRef: type: string example: Payment to John Smith for Consultancy in device. description: >- The reference on the transaction for your records - not shown to the beneficiary. yourRef: type: string example: ACME LTD - INV 23434 description: >- The reference on the transaction - displayed on the beneficiary bank statement. paymentReason: type: string example: 'Invoice Payment, Salary/Dividend Payment' description: >- The reason for the payment, used for transaction monitoring purposes. Must be one of Invoice Payment|Salary/Dividend Payment|Expenses|Savings|Other Mandate: title: mandate type: object properties: mandateUuid: type: string description: The UUID for the mandate example: 28d627c3-1889-44c8-ae59-6f6b20239260 currency: $ref: '#/components/schemas/Currency' status: type: string enum: - CREATED - LIVE - REJECT_REQUESTED - REJECT_RECORD_IN_PROGRESS - REJECT_RECORDED - REJECT_FILE_CREATED - REJECT_FILE_SENT - CANCEL_REQUESTED - CANCEL_RECORD_IN_PROGRESS - CANCEL_RECORDED - CANCEL_FILE_CREATED - CANCEL_FILE_SENT - COMPLETE - DORMANT description: | The status of the mandate. * 'CREATED' * 'LIVE' * 'REJECT_REQUESTED' * 'REJECT_RECORD_IN_PROGRESS' * 'REJECT_RECORDED' * 'REJECT_FILE_CREATED' * 'REJECT_FILE_SENT' * 'CANCEL_REQUESTED' * 'CANCEL_RECORD_IN_PROGRESS' * 'CANCEL_RECORDED' * 'CANCEL_FILE_CREATED' * 'CANCEL_FILE_SENT' * 'COMPLETE' * 'DORMANT' example: RECIEVED originatorReference: type: string description: Set by party who sets up the direct debit. example: VODA-123456 originatorName: type: string description: The creator of the party who sets up the direct debit. example: Vodafone PLC originatorAlias: type: string example: Vodaphone PLC description: The name of the alias originatorLogoUrlSmall: type: string description: Logo url from party who sets up the direct debit. example: originatorLogoSmall originatorLogoUrlLarge: type: string description: Logo url from party who sets up the direct debit. example: originatorLogoLarge mandateReference: type: string example: CRZ-102190123 description: the reference of the mandate alias: type: string example: Vodaphone description: The name of the alias targetIcan: type: integer format: int64 example: 1 description: Identifier for the fire.com account (assigned by fire.com) numberOfDirectDebitCollected: type: integer format: int64 example: 2 description: The number of direct debits collected valueOfDirectDebitCollected: type: integer format: int64 example: 2 description: The value of direct debits collected latestDirectDebitAmount: type: integer format: int64 example: 2 description: The value of largest direct debit collected latestDirectDebitDate: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: The date of latest direct debit collected fireRejectionReason: type: string enum: - ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS - DDIC - ACCOUNT_NOT_FOUND - ACCOUNT_NOT_LIVE - CUSTOMER_NOT_FOUND - BUSINESS_NOT_LIVE - BUSINESS_NOT_FULL - PERSONAL_USER_NOT_LIVE - PERSONAL_USER_NOT_FULL - MANDATE_ALREADY_EXISTS - MANDATE_WITH_DIFERENT_ACCOUNT - NULL_MANDATE_REFERENCE - INVALID_ACCOUNT_CURRENCY - INVALID_MANDATE_REFERENCE - REQUESTED_BY_CUSTOMER_VIA_SUPPORT - CUSTOMER_ACCOUNT_CLOSED - CUSTOMER_DECEASED - ACCOUNT_TRANSFERRED - MANDATE_NOT_FOUND - ACCOUNT_TRANSFERRED_TO_DIFFERENT_ACCOUNT - INVALID_ACCOUNT_TYPE - MANDATE_EXPIRED - MANDATE_CANCELLED - REQUESTED_BY_CUSTOMER description: Rejection reason if transaction is rejected example: ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS schemeCancelReason: type: string description: Reason for cancelation example: e.g. Instruction cancelled by payer schemeCancelReasonCode: type: string example: For BACS (ADDACS) - 0|1|2|3|B|C|D|E|R description: >- The cancelation code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason. lastUpdated: type: string format: date-time description: >- Date the direct debit was last updated. Milliseconds since the epoch (1970). example: '2016-12-15T22:56:05.937Z' dateCreated: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: >- Date the direct debit was created. Milliseconds since the epoch (1970). dateCompleted: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: >- Date the direct debit was completed. Milliseconds since the epoch (1970). dateCancelled: type: string format: date-time example: '2016-12-15T22:56:05.937Z' description: >- Date the direct debit was canceled. Milliseconds since the epoch (1970). MobileApplication: title: mobileApplication type: object properties: businessUserId: type: integer format: int64 description: Business user ID example: '14059' mobileApplicationId: type: integer format: int64 description: Mobile application id for user. example: '18967' clientID: type: string description: Client ID of user. example: EBB10F29-A653-4DBA-9C8C-BA79F72F78B0 status: type: string description: Status of user enum: - LIVE - CLOSED - LOCKED - SMS_SENT deviceName: type: string enum: - iPhone - Android - Other description: type of device. OS: type: string enum: - Android - IOS - OTHER description: Operating system of device. deviceOSVersion: type: string description: OS version for device. example: '14.4' NewApiApplication: title: newApiApplication type: object properties: applicationName: type: string description: A name for the API Application to help you identify it example: Batch Processing API numberOfPaymentApprovalsRequired: type: integer description: Number of approvals required to process a payment in a batch example: 1 numberOfPayeeApprovalsRequired: type: integer description: Number of approvals required to create a payee in a batch example: 1 isPayeeCheckEnabled: type: boolean description: >- This is whether or not Verfication of Payee checks are required for SEPA payments before a batch can be submitted. permissions: type: array items: type: string description: The list of permissions required example: - PERM_BUSINESS_POST_PAYMENT_REQUEST - PERM_BUSINESS_GET_ASPSPS NewBatchResponse: title: newBatchResponse type: object properties: batchUuid: type: string example: F2AF3F2B-4406-4199-B249-B354F2CC6019 description: A UUID for this item. NewBatch: title: newBatch type: object properties: type: type: string enum: - BANK_TRANSFER - INTERNAL_TRANSFER - INTERNATIONAL_TRANSFER description: The type of the batch - can be one of the listed 3 currency: type: string example: EUR description: >- 3 digit ISO code for the currency you wish to send - GBP, EUR, USD, CAD, etc... batchName: type: string example: January 2018 Payroll description: An optional name you give to the batch at creation time. jobNumber: type: string example: 2022-01-PR description: >- An optional job number you can give to the batch to help link it to your own system. callbackUrl: type: string example: 'https://my.webserver.com/cb/payroll' description: An optional POST URL that all events for this batch will be sent to. NewPaymentRequest: title: newPaymentRequest type: object required: - type - icanTo - currency - myRef - description properties: currency: type: string enum: - EUR - GBP description: >- Either `EUR` or `GBP`, and must correspond to the currency of the account the funds are being lodged into in the `icanTo`. type: type: string enum: - OTHER description: The type of Fire Open Payment that was created icanTo: type: integer format: int64 example: 42 description: >- The ican of the account to collect the funds into. Must be one of your fire.com Accounts. amount: type: integer format: int64 example: 1000 description: >- The requested amount to pay. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). myRef: type: string example: Fees description: An internal description of the request. description: type: string example: Gym Fees Oct 2020 description: >- A public facing description of the request. This will be shown to the user when they tap or scan the request. Fire will truncate to 18 characters to ensure it is accepted by all banks. It is safest to use only numbers, letters, spaces and a fullstop (.) Special characters are not accepted by most banks and errors will only occur after the customer has approved the payment. maxNumberPayments: type: integer example: 1 description: >- The max number of people who can pay this request. Must be set to 1 for the ECOMMERCE_GOODS and ECOMMERCE_SERVICES types. expiry: type: string format: date-time example: '2020-10-22T07:48:56.460Z' description: >- This is the expiry of the payment request. After this time, the payment cannot be paid. returnUrl: type: string example: 'https://example.com/callback' description: >- The merchant return URL where the customer will be re-directed to with the result of the transaction. The returnUrl variable should handle two scenarios. If the user cancels the payment before reaching their banking app, URLs are identified with a /return?status=cancelled. If the user proceeds to their banking app, URLs are identified with /paymentUUID={paymentUUID} orderDetails: $ref: '#/components/schemas/OrderDetails' collectFields: type: string example: ADDRESS|REFERENCE|COMMENT1 description: >- 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. mandatoryFields: type: string example: ADDRESS|REFERENCE|COMMENT1 description: >- 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. additionalFields: type: string example: ORDER_ID|PRODUCT_ID|CUSTOMER_ID|CUSTOMER_NUMBER|COMMENT2 description: >- These fields will be displayed 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. OrderDetails: title: orderDetails type: object properties: merchantNumber: type: string example: '1234567' description: Your Merchant Number (if applicable). orderId: type: string example: 6c28a47d-4502-4111 description: >- Use this field to store the order id for the transaction. The Order Id cannot be set unless the `maxNumberPayments` is 1. productId: type: string example: ZFDAA-1221 description: >- Use this field to store a product id for the transaction (for example). customerNumber: type: string example: '123645' description: >- Use this field to store a customer number for the transaction (for example). variableReference: type: string example: John Doe description: >- Use this field to store any other reference for the transaction (for example, a phone number). comment1: type: string example: Additional comments about the transaction description: This is your own comment for the transaction. comment2: type: string example: Additional comments about the transaction description: This is your own comment for the transaction. merchantCustomerIdentification: type: string example: CustNum-303863544 description: >- This is a reference you use to uniquely identify each of your customers. deliveryAddressLine1: type: string example: 12 The Street description: The first line of the delivery address. deliveryAddressLine2: type: string example: The Way description: The second line of the delivery address. deliveryCity: type: string example: London description: Delivery address city deliveryPostCode: type: string example: EC15155 description: Delivery address post code deliveryCountry: type: string example: GB description: 2-digit code for the country Payee: title: payee type: object properties: id: type: integer format: int64 description: >- Identifier for the fire.com payee bank account (assigned by fire.com). example: 742 currency: $ref: '#/components/schemas/Currency' status: type: string enum: - CREATED - LIVE - CLOSED - ARCHIVED description: > The status of the payee. Only payees in LIVE status can be selected as a destination account for an outgoing payment. * 'CREATED' - The payee has been set-up via Bank Transfer Received, Direct Debit, or Open Banking. This payee must be converted to LIVE status to select as a destination account for an outgoing payment. * 'LIVE' - The payee can be selected as a destination account for an outgoing payment. * 'CLOSED' * 'ARCHIVED' - The payee has been deleted and must be added again to be selected as a destination account for an outgoing payment. example: LIVE accountName: type: string description: >- The alias attributed to the payee, usually set by the user when creating the payee. example: Joe accountHolderName: type: string description: The name on the payee bank account. example: Joe Bloggs bic: type: string description: The BIC of the account if currency is EUR. example: BOFIIE2DXXX iban: type: string description: The IBAN of the account if currency is EUR. example: IE86BOFI90535211111111 nsc: type: string description: The Sort Code of the account if currency is GBP. example: '998822' accountNumber: type: string description: The Account Number of the account if currency is GBP. example: '12345678' combinedAccountNumbers: type: string description: >- BIC and IBAN for domestic payees. Account numbers for international payees createdBy: type: string enum: - CUSTOMER - LODGEMENT - DIRECT_DEBIT - OPEN_BANKING - FIRE_OPEN_PAYMENT - FIRE_DIRECT - PAYMENT_ORIGINATING_OVERSEAS description: The creation source of the payee. example: CUSTOMER dateCreated: type: string format: date-time example: '2019-08-22T07:48:56.460Z' description: The date the payee was created. ISO Date Time. PaymentRequestPayment: title: paymentRequestPayment type: object properties: type: type: string enum: - OTHER description: The type of Fire Open Payment that was created paymentRequestCode: type: string description: The code that was returned when you created the payment request. example: 1234abcd maxLength: 8 minLength: 8 transactionType: type: string enum: - REFUND_REQUEST - PAYMENT description: The type of payment request payment endToEndId: type: string example: FIRE1234567890 description: The unique Open Banking payment ID assigned to this payment. paymentUuid: type: string description: A unique id for the transaction. example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C relatedPaymentUuid: type: string description: The original payment that this payment is linked to example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C status: type: string enum: - AWAITING_AUTHORISATION - AUTHORISED - AWAITING_MULTI_AUTHORISATION - NOT_AUTHORISED - SETTLED - REJECTED - ACCEPTED - RECEIVED - FUNDS_CONFIRMED description: The status of the transaction reason: type: string example: Gym Closed for repairs. description: The reason for the refund. amountBeforeCharges: type: integer format: int64 example: 1000 description: >- The requested amount (before Fire fees and taxes). Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). feeAmount: type: integer format: int64 example: 1000 description: The fee for the payment amountAfterCharges: type: integer format: int64 example: 1000 description: >- The amount after Fire fees and taxes. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). currency: $ref: '#/components/schemas/Currency' myRef: type: string example: Fees description: An internal description of the request. description: type: string example: Gym Fees Oct 2020 description: >- A public facing description of the request. This will be shown to the user when they tap or scan the request. Fire will truncate to 18 characters to ensure it is accepted by all banks. It is safest to use only numbers, letters, spaces and a fullstop (.) Special characters are not accepted by most banks and errors will only occur after the customer has approved the payment. returnUrl: type: string example: 'https://example.com/callback' description: >- The merchant return URL where the customer will be re-directed to with the result of the transaction. webhookUrl: type: string example: 'https://example.com/webhook' description: >- A URL to be called in the background with the details of the payment after the payment is complete relatedAccountTxnId: type: integer format: int64 example: 41234 description: The ID of the related transaction in your fire account. relatedPayeeId: type: integer format: int64 example: 41234 description: The ID of the payee making the payment. dateFundsReceived: type: string format: date-time example: '2020-10-22T07:48:56.460Z' description: The date the funds were received into your fire account. dateCreated: type: string format: date-time example: '2020-10-22T07:48:56.460Z' description: This is the date the payment was initiated. lastUpdated: type: string format: date-time example: '2019-08-22T07:48:56.460Z' description: The date payment was last updated. orderDetails: $ref: '#/components/schemas/OrderDetails' to: $ref: '#/components/schemas/To' bank: $ref: '#/components/schemas/Aspsp' domesticPaymentId: type: string description: The ID assigned by the ASPSP to this payment. example: sdp-1-66ebd30c-c0e1-4a54-9865-f2a7bfedabcf allowFopReceipt: type: boolean example: true description: whether or not a receipt option was offered to the payer. PaymentRequestResponse: title: newPaymentRequestResponse type: object properties: code: type: string example: 1234abcd description: > The code for this request. Create a URL in this format: `https://payments.fire.com/{code}` and share to your customers. minLength: 8 maxLength: 8 type: type: string enum: - OTHER description: The type of Fire Open Payment that was created. PaymentRequest: title: paymentRequest type: object properties: code: type: string example: 1234abcd description: The code of the payment request called type: type: string example: OTHER description: The type of Payment Request direction: type: string example: SENT description: The direction of the payment request status: type: string example: ACTIVE description: The status of the payment request currency: type: string example: GBP description: The currency the payment request was sent in accountName: type: string example: Sterling Account description: The account associated with the payment request amount: type: integer format: int64 description: The amount of funds associated with the payment request example: 1000 description: type: string example: test description: The description added to the payment request myRef: type: string example: test description: The reference added to the payment request dateCreated: type: string format: date-time example: '2019-08-22T07:48:56.460Z' description: The date that the payment request was created icanTo: type: integer format: int64 description: The ican associated with the payment request example: 1234 orderDetails: $ref: '#/components/schemas/OrderDetails' countTimesViewedPaymentDetailsPage: type: integer format: int64 description: The count of the times the Payment Details page was viewed countTimesViewedSelectBankPage: type: integer format: int64 description: The count of the times the Select Bank page was viewed countTimesViewedConsentPage: type: integer format: int64 description: The count of the times the Consent page was viewed countTimesViewedResponsePage: type: integer format: int64 description: The count of the times the Response page was viewed countTimesConsented: type: integer format: int64 description: The count of the times the payment request was consented to countTimesAuthorised: type: integer format: int64 description: The count of the times the payment request was authorised totalAmountAuthorised: type: integer format: int64 description: The amount the payment request was authorised for countTimesPaid: type: integer format: int64 description: The count of the times the payment request was paid totalAmountPaid: type: integer format: int64 description: The total amount paid via the payment request Permission: title: apiAppPermission type: object properties: name: type: string description: Name of Permission allowed enum: - PERM_BUSINESS_GET_ACCOUNT - PERM_BUSINESS_GET_ACCOUNT_TRANSACTIONS - PERM_BUSINESS_GET_ACCOUNT_TRANSACTIONS_FILTERED - PERM_BUSINESS_GET_ACCOUNTS - PERM_BUSINESS_GET_ACTIVITIES - PERM_BUSINESS_GET_APP_PERMISSIONS - PERM_BUSINESS_GET_APPS - PERM_BUSINESS_GET_CARDS - PERM_BUSINESS_GET_CONNECTION - PERM_BUSINESS_GET_CONNECTIONS - PERM_BUSINESS_GET_FUNDING_SOURCE - PERM_BUSINESS_GET_FUNDING_SOURCE_TRANSACTIONS - PERM_BUSINESS_GET_FUNDING_SOURCES - PERM_BUSINESS_GET_FX_RATE - PERM_BUSINESS_GET_IDENTITY_DOCUMENTS - PERM_BUSINESS_GET_LIMITS - PERM_BUSINESS_GET_ME - PERM_BUSINESS_GET_MY_AUTHENTICATORSECRET - PERM_BUSINESS_GET_MY_CARD_PIN - PERM_BUSINESS_GET_MY_CARD_TRANSACTIONS - PERM_BUSINESS_GET_MY_CARD_TRANSACTIONS_FILTERED - PERM_BUSINESS_GET_MY_PINGRID - PERM_BUSINESS_GET_OPERATING_COUNTRIES - PERM_BUSINESS_GET_MY_CARDS - PERM_BUSINESS_GET_PAYMENT_REQUEST_REPORTS - PERM_BUSINESS_GET_PAYMENT_REQUEST_TRANSACTIONS - PERM_BUSINESS_GET_PAYMENT_REQUESTS - PERM_BUSINESS_GET_PAYMENT_REQUEST_PAYMENTS - PERM_BUSINESS_GET_PUBLIC_PAYMENT_REQUEST - PERM_BUSINESS_GET_PAYMENT_REQUEST - PERM_BUSINESS_GET_RATES - PERM_BUSINESS_GET_SERVICES - PERM_BUSINESS_GET_USER - PERM_BUSINESS_GET_USER_ADDRESS - PERM_BUSINESS_GET_USERS - PERM_BUSINESS_GET_WEBHOOK_EVENT_TEST - PERM_BUSINESS_GET_WEBHOOK_TOKENS - PERM_BUSINESS_GET_WEBHOOKS - PERM_BUSINESS_GET_MY_NOTIFICATIONS_PUSH - PERM_BUSINESS_GET_MY_SCAAA - PERM_BUSINESS_GET_MY_SCAAAS - PERM_BUSINESS_GET_BATCHES - PERM_BUSINESS_GET_BATCH - PERM_BUSINESS_GET_BATCH_INTERNALTRANSFERS - PERM_BUSINESS_GET_BATCH_BANKTRANSFERS - PERM_BUSINESS_GET_BATCH_NEWPAYEES - PERM_BUSINESS_GET_BATCH_APPROVALS - PERM_BUSINESS_GET_MANDATE - PERM_BUSINESS_GET_MANDATES - PERM_BUSINESS_GET_DIRECT_DEBIT - PERM_BUSINESS_GET_DIRECT_DEBITS - PERM_BUSINESS_POST_ACCOUNT_WITHDRAWAL - PERM_BUSINESS_POST_ACCOUNTS - PERM_BUSINESS_POST_ACCOUNTS_TRANSFER - PERM_BUSINESS_POST_APPS - PERM_BUSINESS_POST_CARDS - PERM_BUSINESS_POST_CONNECTION_EXTERNAL_ACCOUNT_PAY - PERM_BUSINESS_POST_CONNECTION_PAY - PERM_BUSINESS_POST_CONNECTION_PAYMENT_REQUESTS - PERM_BUSINESS_POST_CONNECTIONS - PERM_BUSINESS_POST_FUNDING_SOURCES - PERM_BUSINESS_POST_FX_TRANSFER - PERM_BUSINESS_POST_IDENTITY_DOCUMENTS_POLICY - PERM_BUSINESS_POST_MY_CARD_ACTIVATE - PERM_BUSINESS_POST_MY_CARD_BLOCK - PERM_BUSINESS_POST_MY_CARD_UNBLOCK - PERM_BUSINESS_POST_MY_PIN_RESET - PERM_BUSINESS_POST_MY_PIN_RESET_INITIATE - PERM_BUSINESS_POST_PAYMENT_REQUEST - PERM_BUSINESS_POST_PIN - PERM_BUSINESS_POST_USERS - PERM_BUSINESS_POST_WEBHOOKS - PERM_BUSINESS_POST_BATCHES - PERM_BUSINESS_POST_BATCH_INTERNALTRANSFERS - PERM_BUSINESS_POST_BATCH_BANKTRANSFERS - PERM_BUSINESS_PUT_ACCOUNT - PERM_BUSINESS_PUT_APP - PERM_BUSINESS_PUT_CONNECTION - PERM_BUSINESS_PUT_FUNDING_SOURCE_ARCHIVE - PERM_BUSINESS_PUT_IDENTITY - PERM_BUSINESS_PUT_MY_AUTHENTICATORSECRET - PERM_BUSINESS_PUT_PAYMENT_REQUEST_STATUS - PERM_BUSINESS_PUT_REGISTRATION_DETAILS - PERM_BUSINESS_PUT_USER_DISABLE - PERM_BUSINESS_PUT_USER_RESEND_EMAIL - PERM_BUSINESS_PUT_MY_NOTIFICATION_PUSH - PERM_BUSINESS_PUT_OTHERS_NOTIFICATION_PUSH - PERM_BUSINESS_PUT_MY_SCAAA - PERM_BUSINESS_PUT_BATCH - PERM_BUSINESS_DELETE_CONNECTION - PERM_BUSINESS_DELETE_IDENTITY_DOCUMENT - PERM_BUSINESS_DELETE_WEBHOOK - PERM_BUSINESS_DELETE_BATCH - PERM_BUSINESS_DELETE_BATCH_INTERNALTRANSFERS - PERM_BUSINESS_DELETE_BATCH_BANKTRANSFERS - PERM_BUSINESS_GET_TERMINAL_PAYMENT_REQUEST - PERM_BUSINESS_GET_TERMINAL_PAYMENT_REQUEST_PAYMENTS - PERM_BUSINESS_GET_TERMINAL_ACCOUNTS requiresElevatedPrivilege: type: boolean ProprietarySchemeDetails: title: proprietarySchemeDetails description: >- Extra details about the transaction based on the scheme used to make the payment. type: array items: type: object properties: type: type: string description: >- the type of proprietary scheme - SCT for SEPA, FPS for Faster Payments etc. example: SCT data: type: string example: >- remittanceInfoUnstructured^FIRE440286865OD1|instructionId^O223151336499079 description: >- the scheme proprietary data - key pairs separated by | and key/values separated by ^ RelatedCard: title: relatedCard description: Details of the card used (if applicable) type: object properties: cardId: type: integer format: int64 provider: type: string alias: type: string maskedPan: type: string embossCardName: type: string embossBusinessName: type: string expiryDate: type: string format: date-time RelatedPartyCardPayment: title: relatedPartyCardPayment type: object properties: type: type: string enum: - CARD_MERCHANT - CARD_ATM cardMerchant: type: object properties: acquirerIdDe32: type: string example: 06011329 additionalAmtDe54: type: string authCodeDe38: type: string example: '177449' billAmt: type: integer format: int64 example: -1000 billCcy: type: string example: '978' expiryDate: type: string mccCode: type: string example: '5521' merchIdDe42: type: string example: 013152429 merchNameDe43: type: string example: ABC Coffee Shop posDataDe61: type: string example: 000001000030037299999 posTermnlDe41: type: string example: '80266721' posDataDe22: type: string example: '051' procCode: type: string example: '000000' respCodeDe39: type: string example: '00' retRefNoDe37: type: string example: 010900006720 statusCode: type: string example: '00' token: type: string example: '976307363' txnAmt4d: type: integer format: int64 example: 1000 txnCcy: type: string example: '978' txnCtry: type: string example: IRL txnDesc: type: string example: ABC Coffee Shop txnStatCode: type: string example: A txnType: type: string example: A additionalDataDe48: type: string example: 010X610500000 authorisedByGps: type: string example: 'N' avsResult: type: string example: 'N' mtId: type: string example: '0100' recordDataDe120: type: string additionalDataDe124: type: string RelatedPartyExternalAccount: title: relatedPartyExternalAccount type: object properties: type: type: string enum: - EXTERNAL_ACCOUNT account: type: object properties: id: type: integer format: int64 alias: type: string description: the name the user gives to the account to help them identify it. example: Main Account nsc: type: string example: '232221' description: the Sort Code of the account. accountNumber: type: string example: '11111111' description: the Account Number of the account. bic: type: string example: CPAYIE2D description: the BIC of the account (provided if currency is EUR). iban: type: string example: IE54CPAY99119911111111 description: the IBAN of the account (provided if currency is EUR). RelatedPartyFireAccount: title: relatedPartyFireAccount type: object properties: type: type: string enum: - FIRE_ACCOUNT account: type: object properties: id: type: integer format: int64 description: identifier for the fire.com account (assigned by fire.com) example: 42 alias: type: string description: the name the user gives to the account to help them identify it. example: Main Account bic: type: string example: CPAYIE2D description: the BIC of the account (provided if currency is EUR). iban: type: string example: IE54CPAY99119911111111 description: the IBAN of the account (provided if currency is EUR). nsc: type: string example: '232221' description: the Sort Code of the account. accountNumber: type: string example: '11111111' description: the Account Number of the account. RelatedPartyPayee: title: relatedPartyPayee type: object properties: type: type: string enum: - WITHDRAWAL_ACCOUNT account: type: object properties: id: type: integer format: int64 example: 123 description: The ID of the payee. alias: type: string example: Smyth and Co. description: The name of the payee. nsc: type: string example: '991199' description: The sort code of the payee (for GBP payments) accountNumber: type: string example: '00000000' description: The account number of the payee (for GBP payments) bic: type: string example: CPAYIE2D description: The BIC of the payee (for EUR payments) iban: type: string example: IE76CPAY99119900000000 description: The IBAN of the payee (for EUR payments) RelatedParty: title: relatedParty description: Details of the related third party involved in the transaction. oneOf: - $ref: '#/components/schemas/RelatedPartyFireAccount' - $ref: '#/components/schemas/RelatedPartyExternalAccount' - $ref: '#/components/schemas/RelatedPartyPayee' - $ref: '#/components/schemas/RelatedPartyCardPayment' To: title: to type: object properties: type: type: string enum: - FIRE_ACCOUNT - WITHDRAWAL_ACCOUNT example: FIRE_ACCOUNT description: the type of destination account. account: $ref: '#/components/schemas/RelatedPartyFireAccount' User: title: user type: object properties: id: type: integer format: int64 description: The User ID for this User example: 14059 emailAddress: type: string description: email address for user example: user@example.com firstName: type: string description: User first name example: Colm lastName: type: string description: User second name example: User mobileNumber: type: string description: User mobile number example: '+353871234567' role: type: string description: User role enum: - ADMIN - FULL_USER - PAYMENT_ONLY_USER - PAYEE_MANAGEMENT - READ_ONLY - CARD_ONLY status: type: string description: Status of user enum: - LIVE - CLOSED - FROZEN - INVITE_SENT - SMS_CODE_SENT lastlogin: type: string description: Timestamp on when user last logged in. example: '2012-01-20T11:21:35.000Z' userCvl: type: string description: Users Cvl type ID (shows up when status is LIVE) example: FULL mobileApplicationDetails: $ref: '#/components/schemas/MobileApplication' NewWebhook: title: newWebhook type: object properties: webhookUrl: type: string format: uri example: 'https://example.com/callback' webhookEvents: type: array items: type: string enum: - LODGEMENT_RECEIVED - PAYMENT_RECEIVED - PAYMENT_REQUEST_PAYMENT_RECEIVED - ACCOUNT_CREATED - CARD_CREATED - CARD_AUTHORISATION - CARD_SETTLEMENT - PAYMENT_REQUEST_PAYMENT_AUTHORISED - PIS_LODGEMENT_RECEIVE example: CARD_AUTHORISATION AccountConfiguration: title: accountConfiguration type: object properties: accountName: type: string description: This is the name the account will be updated to. example: John Doe Activity: title: activity type: object properties: id: type: integer format: int64 description: Identifier for the fire.com account (assigned by fire.com) example: 7448413 userId: type: integer format: int64 description: User id assigned by fire.com example: 3138 type: type: string description: Type of the activity enum: - PAYMENT_MADE - PAYMENT_RECEIVED - MANUAL_WITHDRAWAL - EDIT_CARAPIN - EDIT_PASSWORD - USER_CREATED - FUNDING_SOURCE_ADDED - FUNDING_SOURCE_VALIDATED - LODGEMENT_RECEIVED - RESET_PASSWORD - RESET_CARAPIN - LOGIN_FAILED - LOGIN_SUCCESS - ACCOUNT_CREATED - INTERNAL_TRANSFER_MADE - PAYMENT_REQUEST_SENT - PAYMENT_REQUEST_RECEIVED - EDIT_ACCOUNT_NAME - SETTING_ENABLED - SETTING_DISABLED - PASSWORD_LOCKED - CARAPIN_LOCKED - NATIVE_APPLICATION_REGISTRATION_LOCKED - NATIVE_APPLICATION_USER_STATUS_CHANGED - PAYMENT_ACKNOWLEDGED - WITHDRAWAL_RETURNED - LODGEMENT_REVERSED - LODGEMENT_SUSPENDED_INCF_MAX_CPL - VERIFICATION_EVIDENCE_SUBMITTED - ANONYMOUS_PAYMENT_RECEIVED - INCREASE_CVL - PENDING_PAYMENT_RETURNED - PAYMENT_FAILED_BASIC_USER_CP_LIMIT_EXCEEDED - ANONYMOUS_PAYMENT_FAILED_BASIC_USER_CP_LIMIT_EXCEEDED - UPLOAD_PROFILE_PICTURE - EDIT_USER_EMAIL_ADDRESS - TOTP_AUTHENTICATOR_TOKEN_LOCKED - FX_INTERNAL_TRANSFER_MADE - PAYMENT_REQUEST_SAVED - CARD_TOP_UP - ACCOUNT_CREATED_BY_PAYMENT - PAYMENT_REQUEST_PAYMENT_RECEIVED - LODGEMENT_SUSPENDED_BASIC_EXPIRY_REACHED - LODGEMENT_SUSPENDED_USER_SANCTIONED - PERSONAL_EMAIL_VERIFIED - ACCOUNT_CREATED_BY_CARD - CARD_PAYMENT_POS_CONTACT_DEBIT - CARD_PAYMENT_POS_CONTACTLESS_DEBIT - CARD_PAYMENT_ECOMMERCE_DEBIT - CARD_PAYMENT_ATM_DEBIT - CARD_PAYMENT_DECLINED - CARD_PAYMENT_CARD_BLOCKED - CARD_PAYMENT_CARD_NOT_ACTIVATED - CARD_PAYMENT_REFUND - CARD_PAYMENT_AUTH_REVERSAL - CARD_PAYMENT_FINANCIAL_REVERSAL - CARD_PAYMENT_FINANCIAL_DIFFERENT_AMOUNT - CARD_MESSAGE_CHANGE_PIN - CARD_CREATED - CARD_ACTIVATED - CARD_BLOCKED - CARD_UNBLOCKED - ARCHIVE_FUNDING_SOURCE - INTERACTION_MESSAGE_RECEIVED - BUSINESS_API_APPLICATION_CREATED - BUSINESS_API_APPLICATION_DELETED - BUSINESS_MOBILE_APPLICATION_CREATED - BUSINESS_USER_DISABLED - BUSINESS_MOBILE_APPLICATION_DELETED - ANONYMOUS_PAYMENT_REQUEST_PAYMENT_RECEIVED - SCAAA_PING - BUSINESS_ADDITIONAL_USER_CREATED - BUSINESS_BATCH_REQUEST_CANCELLED - BUSINESS_BATCH_REQUEST_SUBMITTED - BUSINESS_BATCH_REQUEST_COMPLETED - BUSINESS_BATCH_REQUEST_SCAAA_SENT - BUSINESS_BATCH_REQUEST_APPROVED - BUSINESS_BATCH_REQUEST_REJECTED - CARD_LINKED_ACCOUNTS_UPDATED - DIRECT_DEBIT_MANDATE_CREATED - DIRECT_DEBIT_MANDATE_COMPLETE - DIRECT_DEBIT_MANDATE_DISALLOWED_BY_ACCOUNT - DIRECT_DEBIT_CREATED - DIRECT_DEBIT_CREATED_INSUFFICIENT_FUNDS_AT_PRESENT - DIRECT_DEBIT_COLLECTED - DIRECT_DEBIT_UNPAID_INSUFFICIENT_FUNDS - STAFF_DIRECT_DEBIT_MANDATE_CANCELLED - STAFF_DIRECT_DEBIT_MANDATE_REJECTED - STAFF_DIRECT_DEBIT_REJECTED - BUSINESS_CREATED - ACCOUNT_DIRECT_DEBITS_ENABLED - ACCOUNT_DIRECT_DEBITS_DISABLED - DIRECT_DEBIT_MANDATE_CANCELLED - DIRECT_DEBIT_MANDATE_UPDATED - DIRECT_DEBIT_REJECTED - DIRECT_DEBIT_REFUND - LOGIN_APPROVAL_REQUESTED - NEW_PAYEE_APPROVAL_REQUESTED - APPROVAL_REQUEST_REJECTED - NEW_USER_APPROVAL_REQUESTED - PAYMENT_REQUEST_PAYMENT_AUTHORISED - PAYMENT_REQUEST_PAYMENT_PAID - BUSINESS_API_APPLICATION_UPDATED - CARD_PAYMENT_OOB_3DS2_AUTHORISATION_REQUEST - CARD_PAYMENT_OOB_3DS2_DECLINED - EDIT_USER_ROLE_APPROVAL_REQUESTED - BUSINESS_USER_ROLE_CHANGED - EXCHANGE_RATE_MONTHLY_REPORT_AVAILABLE - DIRECT_DEBIT_CANCELLED - DIRECT_DEBIT_REVERSED - DIRECT_DEBIT_DISALLOWED_BY_ACCOUNT - CARD_REISSUED - FX_INTERNATIONAL_WITHDRAWAL_CREATED - FX_INTERNATIONAL_WITHDRAWAL_FAILED - FUNDING_SOURCE_FAILED - STAFF_FUNDING_SOURCE_REJECTED - STAFF_BUSINESS_USER_LIVE - NEW_BANK_TRANSFER_APPROVAL_REQUESTED - EDIT_AUTHORISATION_RULE_APPROVAL_REQUESTED - CREATE_AUTHORISATION_RULE_APPROVAL_REQUESTED - BUSINESS_SERVICE_FEE - BUSINESS_UNCOLLECTED_SERVICE_FEE description: type: string description: String describing activity example: You paid John Doe relatedIp: type: string description: IP address related to acivity example: “89.101.154.45” dateCreated: type: string description: Date activity was created example: '“2024-09-10T09:40:54.190Z”' Address: title: userAddress type: object properties: type: type: string description: The type of address this is for the user enum: - HOME - BUSINESS address1: type: string description: This is the 1st line of the address example: '1, Road 1' city: type: string description: This is the city listed for the address example: Dublin country: $ref: '#/components/schemas/Country' postcode: type: string description: This is the postcode listed for the address example: D01 E100 BusinessAddress: title: businessAddress type: object properties: type: type: string description: This is the type of account the sender holds example: BUSINESS address1: type: string description: This is the address of the sender example: '1, 1 street, Dublin' city: type: string description: This is the city the sender lives in example: Dublin 1 country: $ref: '#/components/schemas/Country' BusinessService: title: businessService type: object properties: service: type: string description: The service type of the action enum: - PAYMENT - WITHDRAWAL - LODGEMENT - ADD_ACCOUNT - INTERNAL_TRANSFER - PAYMENT_REQUEST - FX_INT_TRANS_FROM - FX_INT_TRANS_TO - CARD_TOP_UP - CREATE_CARD - NB2P_TO - NP2B_FROM - NP2P_TO - NP2P_FROM - CARAPAY_TRANSFER_FROM - CARAPAY_TRANSFER_TO - CARD_POS_CONTACT_DEBIT - CARD_POS_CONTACT_CREDIT - CARD_POS_CONTACTLESS_DEBIT - CARD_POS_CONTACTLESS_CREDIT - CARD_ECOMMERCE_DEBIT - CARD_ECOMMERCE_CREDIT - CARD_ATM_DEBIT - CARD_ATM_CREDIT - CARD_INTERNATIONAL_POS_CONTACT_DEBIT - CARD_INTERNATIONAL_POS_CONTACT_CREDIT - CARD_INTERNATIONAL_POS_CONTACTLESS_DEBIT - CARD_INTERNATIONAL_POS_CONTACTLESS_CREDIT - CARD_INTERNATIONAL_ECOMMERCE_DEBIT - CARD_INTERNATIONAL_ECOMMERCE_CREDIT - CARD_INTERNATIONAL_ATM_DEBIT - CARD_INTERNATIONAL_ATM_CREDIT - CARD_POS_CONTACT_DEBIT_REVERSAL - CARD_POS_CONTACT_CREDIT_REVERSAL - CARD_POS_CONTACTLESS_DEBIT_REVERSAL - CARD_POS_CONTACTLESS_CREDIT_REVERSAL - CARD_ECOMMERCE_DEBIT_REVERSAL - CARD_ECOMMERCE_CREDIT_REVERSAL - CARD_ATM_DEBIT_REVERSAL - CARD_ATM_CREDIT_REVERSAL - CARD_INTERNATIONAL_POS_CONTACT_DEBIT_REVERSAL - CARD_INTERNATIONAL_POS_CONTACT_CREDIT_REVERSAL - CARD_INTERNATIONAL_POS_CONTACTLESS_DEBIT_REVERSAL - CARD_INTERNATIONAL_POS_CONTACTLESS_CREDIT_REVERSAL - CARD_INTERNATIONAL_ECOMMERCE_DEBIT_REVERSAL - CARD_INTERNATIONAL_ECOMMERCE_CREDIT_REVERSAL - CARD_INTERNATIONAL_ATM_DEBIT_REVERSAL - CARD_INTERNATIONAL_ATM_CREDIT_REVERSAL currency: $ref: '#/components/schemas/Currency' feeRule: $ref: '#/components/schemas/FeeRule' FeeRuleFixedAmount: title: feeRuleFixedAmount type: object properties: feeRuleId: type: integer format: int64 description: The ID of the rule example: 25816 fixedAmount: type: integer format: int64 description: This is the fixed amount for the fee for each event example: 29 FeeRuleMaxMin: title: feeRuleMaxMin type: object properties: feeRuleId: type: integer format: int64 description: The ID of the rule example: 25816 minimumAmount: type: integer format: int64 description: This is the minimum fee amount that can be charged for an event example: 10 maximumAmount: type: integer format: int64 description: This is the maximum fee amount that can be charged for an event example: 29 fixedPercentage4d: type: integer format: int64 description: This is the fixed % amount of a transaction the fee can be example: 1000 FeeRule: title: feeRule description: The rules around the fee being applied oneOf: - $ref: '#/components/schemas/FeeRuleFixedAmount' - $ref: '#/components/schemas/FeeRuleMaxMin' FxRate: title: getFXRates type: object properties: provider: type: string description: The FX transfer provider example: TCC buyCurrency: type: string description: The currency the funds will be exchanged to example: GBP sellCurrency: type: string description: The currency the funds are currently in example: EUR fixedSide: type: string description: The fixed side of the FX transfer example: SELL buyAmount: type: integer format: int64 description: Amount to buy (in buy currency) sellAmount: type: integer format: int64 description: Amount to sell (in sell currency) rate4d: type: integer format: int64 example: 8381 Item: title: item type: object properties: batchItemUuid: type: string description: A UUID for this item example: F2AF3F2B-4406-4199-B249-B354F2CC6019 status: type: string enum: - SUBMITTED - REMOVED - SUCCEEDED - FAILED example: SUCCEEDED description: status of the batch result: title: result type: object properties: code: type: integer format: int64 description: This is the code returned indicating response type example: 510001 message: type: string description: This is the message indicating whether the call was a success example: SUCCESS dateCreated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z lastUpdated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z iban: type: string description: International Banking Account number belonging to the new Payees example: IE81AIBK96735642764123 accountName: type: string description: The name on the account of the new payee example: John Doe accountHolderName: type: string description: The name of the new payee example: John Doe Level: title: level description: Details of the level used for the limit oneOf: - $ref: '#/components/schemas/Service' - $ref: '#/components/schemas/ServiceGroup' Service: title: service description: Utilisation Level Type type: object properties: type: type: string description: Level Type (always "SERVICE") example: SERVICE service: type: string description: The service type for the limit example: CREATE_CARD ServiceGroup: title: serviceGroup type: object properties: type: type: string description: This is the service group type example: BUSINESS_WITHDRAWAL_FULL_DAILY_MONETARY_IE description: type: string description: This is a description of the service group type example: BUSINESS_WITHDRAWAL Limit: title: limit type: object properties: limitType: type: string description: This is type of the limit itself enum: - STATIC_MONETARY - STATIC_COUNT - DAILY_MONETARY - DAILY_COUNT - TOTAL_MONETARY - TOTAL_COUNT level: $ref: '#/components/schemas/Level' country: $ref: '#/components/schemas/Country' currency: $ref: '#/components/schemas/Currency' value: type: integer format: int64 description: This the total availability based on the limit type defined remainingValue: type: integer format: int64 description: This is the remaining availability based on the limit type defined NewPayeesBatch: title: newPayeeBatch type: object properties: total: type: integer format: int64 description: The total number of new Payees example: 1 items: title: items type: array items: $ref: '#/components/schemas/Item' PaymentRequestReport: title: paymentRequestReport type: object properties: currency: type: string description: Currency payment request was sent in example: EUR amount: type: integer format: int64 description: Amount in payment request numberOfTimes: type: integer format: int64 description: Payments made for this amount and currency PaymentRequestSummary: title: paymentRequestSummary type: object properties: accountName: type: string description: Name on the Account example: Euro Account amount: type: integer format: int64 description: Amount of the transaction code: type: string description: The code that was returned when you created the payment request example: 1234abcd minLength: 8 maxLength: 8 currency: type: string description: Currency transaction was completed in example: EUR dateCreated: type: string description: This is the date the payment was initiated. example: '2024-09-12T14:55:03.857Z' description: type: string description: >- A public facing description of the request. This will be shown to the user when they tap or scan the request. Fire will truncate to 18 characters to ensure it is accepted by all banks. It is safest to use only numbers, letters, spaces and a fullstop (.) Special characters are not accepted by most banks and errors will only occur after the customer has approved the payment. example: FIRE/John Doe direction: type: string description: Payment direction example: SENT icanTo: type: integer format: int64 description: >- The ican of the account to collect the funds into. Must be one of your fire.com Accounts. example: 66204 maxNumberPayments: type: integer format: int64 description: >- The max number of people who can pay this request. Must be set to 1 for the ECOMMERCE_GOODS and ECOMMERCE_SERVICES types. example: 1 myRef: type: string description: An internal description of the request. example: Terminal orderDetails: $ref: '#/components/schemas/OrderDetails' status: type: string description: The status of the transaction enum: - AWAITING_AUTHORISATION - AUTHORISED - AWAITING_MULTI_AUTHORISATION - NOT_AUTHORISED - SETTLED - REJECTED - ACCEPTED - RECEIVED - FUNDS_CONFIRMED type: type: string description: The type of Fire Open Payment that was created enum: - OTHER - DIRECT - SHAREABLE - PARTY_TO_PARTY - BILL_PAYMENT - ECOMMERCE_GOODS - ECOMMERCE_SERVICES PaymentRequestsSent: title: paymentRequestsSent type: object properties: total: type: integer format: int64 description: The total number of payment request payments in the list. example: 3 dateRangeTo: type: integer format: int64 description: Date Range example: 1726571260003 paymentRequests: type: array items: $ref: '#/components/schemas/PaymentRequestSummary' Sender: title: sender type: object properties: type: type: string description: This is the type of account the sender holds example: BUSINESS name: type: string description: This is the name of the sender example: johndoe businessAddress: $ref: '#/components/schemas/BusinessAddress' PublicPaymentRequest: title: publicPaymentRequest type: object properties: code: type: string description: This is the payment request code example: abcdefgh pisp: type: string description: Payment Initiation Service Provider example: FIRE status: type: string description: This is the status of the payment request example: ACTIVE currency: $ref: '#/components/schemas/Currency' amount: type: integer format: int64 description: The amount sent in the payment request description: type: string description: >- This is the reference description that was added to the payment request example: test dateCreated: type: string description: This is the date the payment was initiated. example: '2024-09-12T14:55:03.857Z' mandatoryFields: type: string description: >- 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. example: REFERNCE sender: $ref: '#/components/schemas/Sender' Result: title: result type: object properties: code: type: integer format: int64 description: This is the code returned indicating response type example: 510001 message: type: string description: This is the message indicating whether the call was a success example: SUCCESS WebhookToken: title: webhookToken type: object properties: tokenId: type: integer format: int64 description: This is the token ID example: 271 publicToken: type: string description: This is the public token (key) shared with the client example: 1287bbbd-e8a8-4ffe-94e3-911896cafd61 privateToken: type: string description: This is the private token that Fire keeps example: d48c6590-dea2-46bf-b8e1-f715de144aca active: type: boolean description: This is whether or not the webhook token is active dateCreated: type: string format: date-time example: '2017-11-09T15:57:15.710Z' Webhook: title: webhook type: object properties: id: type: integer format: int64 description: This is the ID for the webhook created example: 411 businessId: type: integer format: int64 description: This is the associated ID for the business using the webhook example: 543 webhookUrl: type: string description: This is the URL where the webhook is embedded example: 'https://webhook.site/756b7f6b-8c05-4067-93cd-d1cbca824e99' failedSendingCounter: type: integer format: int64 description: >- This is the counter of the number of times the webhook has failed, for any reason example: 24 WebhookEvent: title: webhookEvent type: object properties: webhook: $ref: '#/components/schemas/Webhook' events: $ref: '#/components/schemas/Events' BatchItemBankTransferMode1: title: batchItemBankTransferMode1 type: object properties: icanFrom: type: integer format: int64 example: 2001 description: >- The Fire account ID for the fire.com account the funds are taken from. payeeId: type: integer format: int64 example: 15002 description: The ID of the existing or automatically created payee payeeType: type: string enum: - PAYEE_ID example: PAYEE_ID description: Use PAYEE_ID if you are paying existing approved payees (Mode 1). amount: type: integer format: int64 example: 500 description: >- The amount of funds to be transferred. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). myRef: type: string maxLength: 50 example: Payment to John Smith for Consultancy in device. description: >- The reference on the transaction for your records - not shown to the beneficiary. yourRef: type: string maxLength: 50 example: ACME LTD - INV 23434 description: >- The reference on the transaction - displayed on the beneficiary bank statement. BatchItemBankTransferMode2: title: batchItemBankTransferMode2 type: object properties: icanFrom: type: integer format: int64 example: 2001 description: >- The Fire account ID for the fire.com account the funds are taken from. payeeType: type: string enum: - ACCOUNT_DETAILS example: ACCOUNT_DETAILS description: >- Use ACCOUNT_DETAILS if you are providing account numbers/sort codes/IBANs (Mode 2). Specify the account details in the destIban, destAccountHolderName, destNsc or destAccountNumber fields as appropriate. destIban: type: string maxLength: 34 example: IE00AIBK93123412341234 description: The destination IBAN if a Euro Bank transfer destNsc: type: string maxLength: 6 example: '123456' description: The destination Nsc if a GBP bank transfer destAccountNumber: type: string maxLength: 8 example: '12345678' description: The destination Account Number if a GBP bank transfer destAccountHolderName: type: string maxLength: 70 example: John Smith description: The destination account holder name amount: type: integer format: int64 example: 500 description: >- The amount of funds to be transferred. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). myRef: type: string maxLength: 50 example: Payment to John Smith for Consultancy in device. description: >- The reference on the transaction for your records - not shown to the beneficiary. yourRef: type: string maxLength: 50 example: ACME LTD - INV 23434 description: >- The reference on the transaction - displayed on the beneficiary bank statement. BankPayRefundRequest: title: bankPayRefund type: object properties: currency: type: string enum: - EUR - GBP description: Must correspond to the currency of the original payment amount: type: integer format: int64 example: 1000 description: >- The amount to refund. Must be within a certain percentage of the original payment. myRef: type: string example: Fees Refunded description: An internal description of the refund request. description: type: string example: Gym Fees Refunded Oct 2020 description: A public facing description of the refund request. orderDetails: title: BankPayMerchantNumber type: object properties: merchantNumber: type: string example: '1234567' description: Your Merchant Number (if applicable). reason: type: string example: Gym Closed for repairs. description: A reason for the refund. BankPayRefundResponse: title: bankPayRefundResponse type: object properties: status: type: string enum: - REQUEST_ACCEPTED - REQUEST_REJECTED - REJECTED - RECEIVED description: Status of the refund request. refundRequestUuid: type: string example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C description: The unique id for the refund request paymentUuid: type: string example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C description: The unique id for the original payment. AppCreated: title: apiApplicationCreated type: object properties: clientId: type: string description: This is the ID of client associated with the application example: G0919C06D23D-362A-H5D3-E76D8687D6AE refreshToken: type: string description: This is the refresh token associated with the application example: 9C332CF3-1687-4548-8E0E-55E4F0599800 clientKey: type: string description: The Client Key of the new API Application example: 4ADFB67A-0F5B-4A9A-9D74-34437250045C ApiErrorV2: title: apiError type: object properties: code: type: integer format: int64 description: Error Code example: 50051 message: type: string description: The error message example: 'Sorry, we are unable to proceed with your request.' ApiErrorV3: title: apiError type: object properties: code: type: integer format: int64 description: Error Code example: 50051 message: type: string description: The error message example: 'Sorry, we are unable to proceed with your request.' Events: title: events type: array items: type: string enum: - LODGEMENT_RECEIVED - PAYMENT_RECEIVED - PAYMENT_REQUEST_PAYMENT_RECEIVED - ACCOUNT_CREATED - CARD_CREATED - CARD_AUTHORISATION - CARD_SETTLEMENT - PAYMENT_REQUEST_PAYMENT_AUTHORISED - PIS_LODGEMENT_RECEIVE example: CARD_AUTHORISATION WebhookEvents: Title: webhookEvents Type: array items: $ref: '#/components/schemas/WebhookEvent' BatchRequest: title: batchItem type: object properties: batchItemUuid: type: string example: F2AF3F2B-4406-4199-B249-B354F2CC6019 description: A UUID for this item. type: type: string enum: - INTERNAL_TRANSFER - BANK_TRANSFER - NEW_PAYEE - DEPRECATED_LOGIN - DEPRECATED_MANUALLY_ADDED_NEW_PAYEE - DEPRECATED_NEW_USER - INTERNATIONAL_TRANSFER description: The type of batch status: type: string enum: - PENDING_APPROVAL - REJECTED - COMPLETE - OPEN - CANCELLED - PENDING_PARENT_BATCH_APPROVAL - READY_FOR_PROCESSING description: Status of the batch sourceName: type: string example: Account Information Test description: Source name batchName: type: string example: Test Batch description: The name assigned to the batch jobNumber: type: string example: 1234optional description: A name assigned to identiy the batch job executed currency: type: string example: EUR description: The currency the batch job is executed in numberOfItemsSubmitted: type: integer format: int64 example: 1 description: Number of payments in the batch valueOfItemsSubmitted: type: integer format: int64 example: 100 description: Total value of the payments in the batch numberOfItemsFailed: type: integer format: int64 example: 1 description: Number of payments in the batch that failed valueOfItemsFailed: type: integer format: int64 example: 100 description: Total value of failed payments in the batch numberOfItemsSucceeded: type: integer format: int64 example: 0 description: Number of payments in the batch that succeeded valueOfItemsSucceeded: type: integer format: int64 example: 0 description: Total value of successful payments in the batch lastUpdated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z dateCreated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z BatchItemInternalTransfer: title: batchItem-internaltransfer description: The items contained in an internal transfer batch type: object properties: batchItemUuid: type: string example: F2AF3F2B-4406-4199-B249-B354F2CC6019 description: A UUID for this item. status: type: string enum: - SUBMITTED - REMOVED - SUCCEEDED - FAILED example: SUCCEEDED description: status of the batch if internal trasnfer result: type: object description: The outcome of the attempted transaction. properties: code: type: integer format: int64 example: 500001 message: type: string example: SUCCESS dateCreated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z lastUpdated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z feeAmount: type: integer format: int64 example: 0 description: The fee charged by fire.com for the payment. In pence or cent. taxAmount: type: integer format: int64 example: 0 description: >- Any taxes/duty collected by fire.com for this payments (e.g. stamp duty etc). In pence or cent. amountAfterCharges: type: integer format: int64 example: 10000 description: The amount of the transfer after fees and taxes. in pence or cent. icanFrom: type: integer format: int64 example: 2150 description: The Fire account ID of the source account. icanTo: type: integer format: int64 example: 1002 description: The Fire account ID for the fire.com account the funds are sent to. amount: type: integer format: int64 example: 10000 description: The amount of funds to send. In cent or pence ref: type: string example: Testing a transfer via batch description: The reference on the transaction. refId: type: integer format: int64 example: 123782 description: >- The ID of the resulting payment in your account. Can be used to retrieve the transaction using the https://api.fire.com/business/v1/accounts/{accountId}/transactions/{refId} endpoint. BatchItemInternationalTransfer: title: batchItem-internaltransfer description: The items contained in an internal transfer batch type: object properties: batchItemUuid: type: string example: F2AF3F2B-4406-4199-B249-B354F2CC6019 description: A UUID for this item. status: type: string enum: - SUBMITTED - REMOVED - SUCCEEDED - FAILED example: SUCCEEDED description: status of the batch if internal trasnfer result: type: object description: The outcome of the attempted transaction. properties: code: type: integer format: int64 example: 500001 message: type: string example: SUCCESS dateCreated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z lastUpdated: type: string format: date-time example: '2021-04-04T10:48:53.540Z' description: >- The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z feeAmount: type: integer format: int64 example: 0 description: The fee charged by fire.com for the payment. In pence or cent. taxAmount: type: integer format: int64 example: 0 description: >- Any taxes/duty collected by fire.com for this payments (e.g. stamp duty etc). In pence or cent. amountAfterCharges: type: integer format: int64 example: 10000 description: The amount of the transfer after fees and taxes. in pence or cent. icanFrom: type: integer format: int64 example: 2150 description: The Fire account ID of the source account. payeeId: type: integer format: int64 example: 1234 description: The ID of the payee amount: type: integer format: int64 example: 10000 description: The amount of funds to send. In cent or pence paymentReason: type: string example: Other description: Reason for sending myRef: type: string example: Testing a transfer via batch description: The reference on the transaction. yourRef: type: string example: Testing payee ref description: Reference on payee account Alias: title: Alias type: object properties: alias: type: string description: The alias of the mandate example: Mandate1 LocalDetails: title: localDetails type: object properties: nsc: type: string description: the Sort Code of the account example: '232221' accountNumber: type: string description: the account number of the account example: '86449007' bic: type: string description: the BIC of the account example: CPAYIE2D iban: type: string description: the IBAN of the account example: IE93CPAY99119986449007 InternationalDetails: title: internationalDetails type: object properties: status: type: string description: >- The status associated with the request for international account details. enum: - NONE - REQUESTED - LIVE swiftCode: type: string description: >- The SWIFT reachable BIC on the account (if it has international account details) example: TCCLGB2BXXX iban: type: string description: >- The SWIFT reachable IBAN on the account (if it has international account details) example: GB12TCCL1234567887654321 AccountDetails: title: accountDetails type: object properties: localDetails: $ref: '#/components/schemas/LocalDetails' internationalDetails: $ref: '#/components/schemas/InternationalDetails' AccountV2: title: accountV2 type: object properties: ican: type: integer format: int64 description: identifier for the fire.com account (assigned by fire.com) example: 42 name: type: string description: the name the user gives to the account to help them identify it. example: Main Account currency: type: string description: The currency of the account example: EUR balance: type: integer format: int64 description: >- the balance of the account (in minor currency units - pence, cent etc. 434050 == 4,340.50 GBP for a GBP account). example: 23950 status: type: string enum: - LIVE - BREXIT_MIGRATED description: >- Live accounts can be used as normal. Migrated accounts were used before Brexit and are read-only. accountDetails: $ref: '#/components/schemas/AccountDetails' defaultAccount: type: boolean example: true description: >- 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). directDebitsAllowed: type: boolean example: false description: Whether or not direct debits can be set up on this account. fopOnly: type: boolean example: false description: >- Indicates that this account is for collecting Fire Open Payments only. All other payments to this account will be returned. Status: title: paymentRequestReport type: object properties: status: type: string description: The status to update the payment request to example: ACTIVE PayeeCheck: title: payeeChecks type: object properties: countFullMatch: type: integer format: int64 example: 1 descripton: The number of full match VoP results in the batch countPartialMatch: type: integer format: int64 example: 1 descripton: The number of partial match VoP results in the batch countNoMatch: type: integer format: int64 example: 1 descripton: The number of no match VoP results in the batch countUnableToMatch: type: integer format: int64 example: 1 description: The number of payees on which a VoP check was not completed countPending: type: integer format: int64 example: 1 description: The number of payees awaiting a VoP check result security: - bearerAuth: [] tags: - name: Authentication description: Access to the API is by Bearer Access Tokens. - name: Accounts description: Fire accounts are the equivalent of a bank account from bank. - name: Transactions description: >- There are many types of transactions. They are all represented by the same JSON object with a different txnType. - name: Batch Payments description: >- The Fire API allows businesses to automate payments between their accounts or to third parties across the UK and Europe. - name: Open Banking description: >- 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. - name: Debit Cards description: View and manage the cards linked to your accounts. - name: FX description: View your FX rates - name: Payees description: List the beneficiaries associated with the account. - name: Direct Debits description: >- The fire.com api allows businesses to automate direct debit payment actions on their fire.com business accounts. - name: API and Webhooks description: Manage your API Applications and Webhooks - name: Profile Management description: Manage and view your users and fees. - name: Webhooks description: Events you can receive in realtime