Skip to main content

ark:Transaction

idstring<uri>required

URI format identifier used to refer to this node within the graph.

Example: https://graph.datawollet.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
typestringrequired

A type identifier used to indicate the data model that the node conforms to.

Constant value: ark:Transaction
Example: ark:Transaction
sequencestringrequired

This identifier is designed to allow transactions to be sorted to match the data source exactly, by sorting alphanumerically. It is generated using data from the source systems, or for statement sources from the order of the pages and the order within the pages.

Possible values: non-empty

Example: 20250620001000000001
datestring<date>required

Date on which the transaction was booked, or took place if not yet booked.

relatedTostring<uri>required

Account the transaction is related to.

Example: https://graph.datawollet.com/.draft-nodes/0118735d359276fd42741493c449e568
fullDescriptorstringrequired
PersonalFinancialSensitiveGDPRPSR2017

Full description of the transaction as it appears on the statement. If no description is provided on the statement, then a single hyphen ('-') is used to indicate no description was available.

Possible values: non-empty

Example: B JONES (Faster Payments) Reference: SPOTIFY
descriptionstring
PersonalFinancialSensitiveGDPRPSR2017

Short description of the transaction, if it was possible to determine.

Example: B JONES (Faster Payments)
notesstring
PersonalFinancialSensitiveGDPRPSR2017

Additional details for the transaction that are less important.

Example: Reference: SPOTIFY
methodstring

Method used for the transaction, as described by the bank.

Example: Faster Payments
referencestring
PersonalFinancialSensitiveGDPRPSR2017

Reference for the transaction, if available.

Example: SPOTIFY
methodCategoryrequired

Category for the method used in the transaction, standardised between banks.

Possible values: [PAYMENT, PAYMENT:ONLINE, PAYMENT:DIRECT_DEBIT, PAYMENT:STANDING_ORDER, PAYMENT:CARD, PAYMENT:CARD:CONTACTLESS, TRANSFER, TRANSFER:OUT, TRANSFER:FASTER, TRANSFER:SAVINGS:OUT, TRANSFER:SAVINGS:IN, TRANSFER:P2P, TRANSFER:CHAPS, CREDIT, UNKNOWN]

Example: TRANSFER:FASTER
amount object

Amount involved in the transaction, including currency.

type
Constant value: ark:CurrencyValue
amountstringrequired

Possible values: Value must match regular expression ^[0-9]{1,}(\.[0-9]{2})?$

currencystringrequired
directionstringrequired

Possible values: [Credit, Debit]

conversion object

Original currency and exchange rate, if applicable.

typerequired
Constant value: ark:CurrencyConversion
amount object
typerequired
Constant value: ark:CurrencyValue
amountstring
FinancialSensitivePSR2017

Amount of the original transaction currency

Possible values: Value must match regular expression ^[0-9]{1,}(\.[0-9]{2})?$

currencystring

ISO 4217 currency code for the original transaction currency, or '???' if unknown

Possible values: Value must match regular expression ^[A-Z\?]{3}$

ratestring

Exchange rate applied to the original transaction currency. Additional fees may apply in addition to the exchange rate, so an exact conversion to the final amount is not certain.

Possible values: Value must match regular expression ^[0-9]{1,}(\.[0-9]{1,10})?$

balance object

Balance associated with the transaction, at the time specified by the balanceAt field. A balance may not be included for all transactions depending on how the bank operates.

type
Constant value: ark:CurrencyValue
amountstringrequired
FinancialSensitivePSR2017

Possible values: Value must match regular expression ^[0-9]{1,}(\.[0-9]{2})?$

currencystringrequired
directionstringrequired

Possible values: [Credit, Debit]

balanceType

Treatment of the balance, such as whether it is booked or provisional.

Possible values: [Booked, Interim]

Example: Booked
balanceAt object

Whether the balance relates to the opening, interim or closing balance for the period which is normally considered the day of the transaction.

anyOf
Constant value: Opening
counterparty object

Details for the other party involved in a transaction, which may include a name if available as well as sort code and account number details if provided. When receiving money, this is expected to be the sender, and when sending money this is expected to be the recipient.

namestring
PersonalFinancialSensitiveGDPRPSR2017

Name of the counterparty, where available.

sortCodestring

Sort code of the counterparty's bank, if available.

Possible values: Value must match regular expression ^[0-9]{2}-[0-9]{2}-[0-9]{2}$

accountNumberstring
PersonalFinancialSensitiveGDPRPSR2017

Account number of the counterparty, if available.

Possible values: Value must match regular expression ^[0-9]{7,8}$

categoriesstring[]

List of categories assigned to the transaction through AI matching. Some transactions are not assigned to categories, for example if there is no known amount. The first item in the list is the primary category, and the second item is a subsidiary of the primary category.

The current list of primary categories is:

  • travel
  • banking
  • dependent_costs
  • entertainment
  • shopping
  • food_and_drink
  • income
  • transport
  • media_and_telecoms
  • expenses
  • insurance
  • borrowing_and_loans
  • charity
  • health_and_personal_care
  • home
  • taxes
  • pensions_savings_and_investments
  • education
  • gambling_and_lotteries
  • mortgage_and_rent
  • transfers
  • utilities
  • general

The current list of subsidiary categories is:

  • holiday_and_travel_expenses
  • flights_and_airport_expenses
  • other_travel
  • bank_fees_and_currency_exchange
  • other_banking
  • cash_withdrawals
  • interest
  • refunds_and_reversals
  • overdraft_fees
  • unpaid_transactions
  • other_dependent_costs
  • child_support
  • childcare
  • childrens_expenses
  • childrens_school_fees
  • leisure_and_amusement_activities
  • books_and_reading
  • cinema
  • theatre_concerts_and_tickets
  • other_events
  • gaming
  • sport_events
  • other_entertainment
  • hobbies
  • flowers_and_gifts
  • clothing_and_accessories
  • department_stores
  • electronics_appliances_and_technology
  • general_online_shopping
  • other_shopping
  • smoking_and_vaping
  • bars_and_pubs
  • coffee
  • groceries
  • eating_out_and_takeaways
  • speciality_food_and_drink
  • other_eating_out
  • other_food_and_drink
  • benefits
  • deposits
  • other_income
  • child_support_income
  • crypto_platform_incoming
  • rental_income
  • investment_income
  • employment_income
  • pension_income
  • public_transport
  • petrol_and_vehicle_charging
  • parking_and_tolls
  • service_stations
  • taxi
  • vehicle
  • vehicle_rental
  • other_transport
  • broadband
  • digital_media_and_software
  • mobile
  • tv_streaming_services
  • tv_licence
  • tv_broadband_and_mobile
  • other_media_and_telecoms
  • business_expenses
  • financial_and_legal_expenses
  • other_memberships_and_services
  • postage_and_office_supplies
  • other_expenses
  • business_insurance
  • home_insurance
  • other_insurance
  • health_and_life_insurance
  • pet_insurance
  • travel_insurance
  • vehicle_insurance
  • buy_now_pay_later
  • credit_cards
  • debt_management
  • loan_incoming
  • loan_repayment
  • student_loan
  • vehicle_loan
  • other_borrowing_and_loans
  • charity
  • other_charity
  • healthcare
  • beauty
  • sport_accessories_and_equipment
  • dental
  • gym_and_fitness
  • pharmacies_and_health_products
  • optical
  • other_health_and_personal_care
  • home_maintenance
  • furniture
  • gardening
  • laundry
  • other_home
  • household_goods
  • pets
  • council_tax
  • other_taxes
  • crypto_platform_outgoing
  • investments
  • pensions
  • savings
  • other_pensions_savings_and_investments
  • driving_lessons
  • other_education
  • university_and_tuition
  • gambling_and_betting
  • lotteries_and_sweepstakes
  • other_gambling_and_lotteries
  • housing_deposits
  • mortgage
  • rent
  • other_mortgage_and_rent
  • internal_transfers
  • shared_bills_and_expenses
  • transfers_in
  • transfers_out
  • other_transfers
  • utilities_energy
  • other_utilities
  • utilities_water_and_sewage
  • waste_and_recycling
  • other_general
Example: ["travel","public_transport"]
merchantstring<uri>
FinancialSensitiveGDPRPSR2017

Merchant associated with the transaction, if it was possible to determine. This matching is performed automatically and may not be accurate, and indicates the merchant was referred to, therefore it may not be the same as the counterparty. The referred node will be an ark:Organisation or ark:Organisation normally including tags that can be used to infer additional information about the transaction (e.g. gambling providers).

Example: https://graph.datawollet.com/organisation/tesco
processorstring<uri>
FinancialSensitiveGDPRPSR2017

Payment processor associated with the transaction, if it was possible to determine. This matching is performed automatically and may not be accurate, and indicates the payment processor was referred to, therefore it may not be the same as the counterparty. The referred node will be an ark:Organisation or ark:Organisation normally including tags that can be used to infer additional information about the transaction (e.g. BNPL providers) though it should not be taken to indicate the actual nature of the transaction.

Example: https://graph.datawollet.com/organisation/klarna
ark:Transaction
{
"id": "https://graph.datawollet.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
"type": "ark:Transaction",
"sequence": "20250620001000000001",
"date": "2024-07-29",
"relatedTo": "https://graph.datawollet.com/.draft-nodes/0118735d359276fd42741493c449e568",
"fullDescriptor": "B JONES (Faster Payments) Reference: SPOTIFY",
"description": "B JONES (Faster Payments)",
"notes": "Reference: SPOTIFY",
"method": "Faster Payments",
"reference": "SPOTIFY",
"methodCategory": "TRANSFER:FASTER",
"amount": {
"type": "ark:Currency",
"currency": "GBP",
"amount": "5.00",
"direction": "Credit"
},
"conversion": {
"type": "ark:CurrencyConversion",
"amount": {
"type": "ark:Currency",
"currency": "USD",
"amount": "6.50"
},
"rate": "1.30"
},
"balance": {
"type": "ark:Currency",
"currency": "GBP",
"amount": "1234.56",
"direction": "Credit"
},
"balanceType": "Booked",
"balanceAt": "Closing",
"counterparty": {
"name": "B JONES",
"sortCode": "404004",
"accountNumber": "12345678"
},
"categories": [
"travel",
"public_transport"
],
"merchant": "https://graph.datawollet.com/organisation/tesco",
"processor": "https://graph.datawollet.com/organisation/klarna"
}