Merge · Schema

BankFeedTransactionRequestRequest

# The BankFeedTransaction Object ### Description The `BankFeedTransaction` object is used to represent transactions linked to a bank feed account. This includes details about the transaction such as the date, amount, description, and type. ### Usage Example Fetch from the `GET BankFeedTransaction` endpoint to view details of a transaction associated with a bank feed account.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
bank_feed_account	stringnull	The bank feed account associated with the transaction.
transaction_date	stringnull	The date that the transaction occurred.
posted_date	stringnull	The date the transaction was posted to the bank account.
amount	numbernull	The amount of the transaction.
description	stringnull	The description of the transaction.
transaction_type	stringnull	The underlying type of the transaction.
payee	stringnull	The person or merchant who initiated the transaction, or alternatively, to whom the transaction was paid.
credit_or_debit	object	If the transaction is of type debit or credit.
source_transaction_id	stringnull	The customer’s identifier for the transaction.
integration_params	objectnull
linked_account_params	objectnull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BankFeedTransactionRequestRequest",
  "title": "BankFeedTransactionRequestRequest",
  "type": "object",
  "properties": {
    "bank_feed_account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The bank feed account associated with the transaction."
    },
    "transaction_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date that the transaction occurred."
    },
    "posted_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date the transaction was posted to the bank account."
    },
    "amount": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The amount of the transaction."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The description of the transaction."
    },
    "transaction_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The underlying type of the transaction."
    },
    "payee": {
      "type": [
        "string",
        "null"
      ],
      "description": "The person or merchant who initiated the transaction, or alternatively, to whom the transaction was paid."
    },
    "credit_or_debit": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CreditOrDebitEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "If the transaction is of type debit or credit."
    },
    "source_transaction_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The customer\u2019s identifier for the transaction."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    }
  },
  "required": [
    "bank_feed_account"
  ],
  "description": "# The BankFeedTransaction Object\n### Description\nThe `BankFeedTransaction` object is used to represent transactions linked to a bank feed account. This includes details about the transaction such as the date, amount, description, and type.\n\n### Usage Example\nFetch from the `GET BankFeedTransaction` endpoint to view details of a transaction associated with a bank feed account."
}