{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/inscribe/json-schema/inscribe-list-transactions-schema.json",
  "title": "ListTransactions",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/inscribe-transactions-api-openapi.yml#/components/schemas/ListTransactions",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Transaction"
      },
      "description": "A map with a data property that contains an array of transactions. Each entry in the array is a separate transaction object."
    },
    "pagination": {
      "type": "object",
      "properties": {
        "cursor": {
          "type": "string",
          "format": "uuid",
          "description": "A cursor for use in pagination. This cursor is to be used in the next request's cursor parameter to request the next set of transactions."
        }
      }
    },
    "metadata": {
      "$ref": "#/$defs/metadata_transactions_accounts"
    }
  },
  "$defs": {
    "Transaction": {
      "type": "object",
      "description": "A transaction object which contains information about the transaction.",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier for the object."
        },
        "guid": {
          "type": [
            "string",
            "null"
          ],
          "description": "An identifier for the transaction submitted by the data provider."
        },
        "date": {
          "type": "string",
          "format": "date",
          "description": "Date of the transaction."
        },
        "description": {
          "type": "string",
          "description": "Description of the transaction."
        },
        "amount": {
          "type": "integer",
          "description": "Amount of the transaction (in cents)."
        },
        "currency_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ISO 4217 currency code of the transaction."
        },
        "category": {
          "description": "Category of the transaction. This value will be set to null if no category is identified.",
          "enum": [
            "ACCOMMODATION",
            "RENT",
            "HOTELS",
            "BANK_CHARGE",
            "OVERDRAFT",
            "NSF",
            "INTEREST_PAID",
            "ENTERTAINMENT",
            "GAMBLING",
            "INCOME",
            "REVENUE",
            "SALARY",
            "INTEREST_RECEIVED",
            "RETIREMENT",
            "SOCIAL_SECURITY",
            "COMMISSION_RECEIVED",
            "INFRASTRUCTURE",
            "INSURANCE",
            "INVESTMENTS",
            "SAVINGS",
            "TRADING",
            "CRYPTO_TRADING",
            "LOAN",
            "MORTGAGE",
            "CARD_REPAYMENT",
            "MCA",
            "PAYDAY",
            "AUTO_LOAN",
            "BUY_NOW_PAY_LATER",
            "PERSONNEL",
            "REFUND",
            "RETAIL",
            "FOOD_AND_DRINK",
            "GROCERIES",
            "SELF_TRANSFER",
            "SWEEP_TRANSFER",
            "TAX",
            "TRANSPORT",
            "FUEL",
            "UTILITIES",
            "WITHDRAWAL",
            "OTHER",
            "PEER_TO_PEER_TRANSFER"
          ]
        },
        "method": {
          "type": [
            "string",
            "null"
          ],
          "description": "Method by which the transaction was made. This value will be set to null if no method is identified.",
          "enum": [
            "BANK_TRANSFER",
            "CARD_PAYMENT",
            "CASH",
            "CHECK"
          ]
        },
        "vendor": {
          "type": "string",
          "description": "This has been deprecated. Please use merchant instead.",
          "deprecated": true
        },
        "merchant": {
          "type": [
            "string",
            "null"
          ],
          "description": "The merchant associated with the transaction. This value will be set to null if no merchant is identified."
        },
        "data_source": {
          "type": "string",
          "description": "The source of the transaction. The transaction can be from either a bank statement or open banking data.",
          "enum": [
            "BANK_STATEMENT",
            "OPEN_BANKING"
          ]
        }
      }
    },
    "metadata_transactions_accounts": {
      "type": "object",
      "description": "Additional data which provides context about Inscribe's Credit Insights response.",
      "properties": {
        "customer_contains_low_trust_score_documents": {
          "type": "boolean",
          "description": "This value will be set to True if the customer contains any documents under a trust score threshold of 50. Else, this will be set to False."
        },
        "included_data_sources": {
          "type": "object",
          "description": "Lists all documents and open banking data which were used to create the Inscribe Credit Insights.",
          "properties": {
            "documents": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "document_id": {
                    "type": "string",
                    "format": "uuid"
                  }
                }
              }
            },
            "open_banking": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "open_banking_data_id": {
                    "type": "string",
                    "format": "uuid"
                  }
                }
              }
            }
          }
        },
        "excluded_data_sources": {
          "type": "object",
          "description": "Lists all documents and open banking data which were excluded from the Inscribe Credit Insights. Documents can be excluded if they are duplicate documents, or when the include_unreconciled_documents query parameter is set to False.",
          "properties": {
            "documents": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "document_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "exclusion_reason": {
                    "format": "string"
                  }
                }
              }
            },
            "open_banking": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "open_banking_data_id": {
                    "type": "string",
                    "format": "uuid"
                  }
                }
              }
            }
          }
        },
        "query_parameters": {
          "type": "object",
          "description": "Lists the query parameters which were used in the original endpoint request."
        }
      }
    }
  }
}