action fire_get_transactions_by_idv1 {
  label: "List transactions for an account (v1)"
  description: "Retrieve a list of transactions against an account. Recommended to use the v3 endpoint instead."
  provider: fire
  method: GET
  path: "/v1/accounts/{ican}/transactions"
  encoding: json
  input: {
    type: "object"
    properties: {
      ican: {
        type: "integer"
        format: "int64"
        description: "The ican of the account to retrieve"
      }
      limit: {
        type: "integer"
        format: "int64"
        description: "The number of records to return. Defaults to 10 - max is 200."
      }
      offset: {
        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: ["ican", "limit", "offset"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      dateRangeTo: {
        type: "integer"
        description: "milisecond timestamp of date range to value."
      }
      total: {
        type: "integer"
        description: "The total number of card transactions in the list."
      }
      transactions: {
        type: "array"
        items: {
          type: "object"
          properties: {
            amountAfterCharges: {
              type: "integer"
              format: "int64"
              description: "Net amount lodged or taken from the account after fees and charges were applied."
            }
            amountBeforeCharges: {
              type: "integer"
              format: "int64"
              description: "Amount of the transaction before the fees and taxes were applied."
            }
            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)."
            }
            batchItemDetails: {
              type: "object"
              description: "Details of the batch run if this transaction was part of a batch."
              properties: {
                batchItemPublicUuid: {
                  type: "string"
                  description: "The UUID for this item in the batch."
                }
                batchName: {
                  type: "string"
                  description: "The optional name given to the batch at creation time."
                }
                batchPublicUuid: {
                  type: "string"
                  description: "The UUID for this batch."
                }
                jobNumber: {
                  type: "string"
                  description: "The optional job number given to the batch to link it to your own system."
                }
              }
            }
            card: {
              type: "object"
              description: "Details of the card used (if applicable)"
              properties: {
                alias: {
                  type: "string"
                }
                cardId: {
                  type: "integer"
                  format: "int64"
                }
                embossBusinessName: {
                  type: "string"
                }
                embossCardName: {
                  type: "string"
                }
                expiryDate: {
                  type: "string"
                  format: "date-time"
                }
                maskedPan: {
                  type: "string"
                }
                provider: {
                  type: "string"
                }
              }
            }
            currency: {
              type: "object"
              description: "The currency."
              properties: {
                code: {
                  type: "string"
                  description: "The three letter code for the currency - either `EUR` or `GBP`."
                  enum: ["EUR", "GBP"]
                }
                description: {
                  type: "string"
                  description: "The name of the currency"
                }
              }
            }
            date: {
              type: "string"
              format: "date-time"
              description: "Date of the transaction"
            }
            dateAcknowledged: {
              type: "string"
              format: "date-time"
            }
            directDebitDetails: {
              type: "object"
              description: "Details of the direct debit (if applicable)"
              properties: {
                directDebitReference: {
                  type: "string"
                  description: "The direct debit reference."
                }
                directDebitUuid: {
                  type: "string"
                  description: "The UUID for the direct debit payment"
                }
                mandateReference: {
                  type: "string"
                  description: "the reference of the mandate"
                }
                mandateUUid: {
                  type: "string"
                  description: "The UUID for the mandate"
                }
                mandateUuid: {
                  type: "string"
                  description: "The UUID for the mandate"
                }
                originatorAlias: {
                  type: "string"
                  description: "The Alias of the party who sets up the direct debit."
                }
                originatorLogoUrlLarge: {
                  type: "string"
                  description: "URL pointing to a large version of the Originator Logo (if available)"
                }
                originatorLogoUrlSmall: {
                  type: "string"
                  description: "URL pointing to a small version of the Originator Logo (if available)"
                }
                originatorName: {
                  type: "string"
                  description: "The creator of the party who sets up the direct debit."
                }
                originatorReference: {
                  type: "string"
                  description: "Set by party who sets up the direct debit."
                }
              }
            }
            eventUuid: {
              type: "string"
              description: "An internal Fire reference for the transaction (UUID)"
            }
            feeAmount: {
              type: "integer"
              format: "int64"
              description: "The amount of the fee, if any."
            }
            fxTradeDetails: {
              type: "object"
              description: "Details of the FX trade (if applicable)"
              properties: {
                buyAmount: {
                  type: "integer"
                  format: "int64"
                  description: "amount of buyCurrency being bought"
                }
                buyCurrency: {
                  type: "string"
                  description: "currency which is being bought"
                }
                fixedSide: {
                  type: "string"
                  description: "type of trade - BUY or SELL"
                }
                provider: {
                  type: "string"
                  description: "The FX provider used to make the trade."
                }
                rate4d: {
                  type: "integer"
                  format: "int64"
                  description: "exchange rate"
                }
                sellAmount: {
                  type: "integer"
                  format: "int64"
                  description: "amount of sellCurrency being sold"
                }
                sellCurrency: {
                  type: "string"
                  description: "currency which is being sold"
                }
              }
            }
            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."
            }
            myRef: {
              type: "string"
              description: "The comment/reference on the transaction"
            }
            paymentRequestPublicCode: {
              type: "string"
              description: "(FOP payments only) The FOP Payment Code that was used to make this payment."
            }
            proprietarySchemeDetails: {
              type: "array"
              description: "Extra details about the transaction based on the scheme used to make the payment."
              items: {
                type: "object"
                properties: {
                  data: {
                    type: "string"
                    description: "the scheme proprietary data - key pairs separated by | and key/values separated by ^"
                  }
                  type: {
                    type: "string"
                    description: "the type of proprietary scheme - SCT for SEPA, FPS for Faster Payments etc."
                  }
                }
              }
            }
            refId: {
              type: "integer"
              format: "int64"
              description: "The id of the transaction."
            }
            relatedParty: {
              description: "Details of the related third party involved in the transaction."
              type: "object"
            }
            taxAmount: {
              type: "integer"
              format: "int64"
              description: "The amount of the tax, if any (e.g. Stamp duty for ATM transactions)"
            }
            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."
            }
            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	` - 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	` - 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"
            }
            yourRef: {
              type: "string"
              description: "The comment/reference on the transaction that appears on the recipients statement. Only for withdrawals"
            }
          }
        }
      }
    }
  }
}