Skip to main content

Transaction

idstring<uuid>

internal ID of the transaction

accountstring<uuid>

internal ID of the account

referencestring
typeTransactionType (string)

Possible values: [CREDIT, DEBIT, UNKNOWN]

subtypeTransactionSubtype (string)

Possible values: [DIRECTDEBIT, FEE, INTEREST, TRANSFER, OTHER, PAYMENT]

statusTransactionStatus (string)

Possible values: [PENDING, POSTED]

amount object
amountnumberrequired
Example: 123.45
currencyCurrency (string)required

ISO 4217 currency code

Example: USD, EUR, AUD, NZD
fee object
amountnumberrequired
Example: 123.45
currencyCurrency (string)required

ISO 4217 currency code

Example: USD, EUR, AUD, NZD
balance object
amountnumberrequired
Example: 123.45
currencyCurrency (string)required

ISO 4217 currency code

Example: USD, EUR, AUD, NZD
original object
amountnumberrequired
Example: 123.45
currencyCurrency (string)required

ISO 4217 currency code

Example: USD, EUR, AUD, NZD
exchangeRatenumber

original amount * exchange rate = amount

Example: 123.45
datetimestring<date-time>

ISO 8601

Example: 2018-09-15T15:53:00Z
externalIdstring
codestring

the banking transaction code

thirdParty object
idstring<uuid>
namestring
accountNumber objectrequired
schemeNumberScheme (string)required

Possible values: [SORTCODE, IBAN, PAN, BIC, BBAN_SE, BBAN_DK, BBAN_NO, BECS, BSB_NO, MASKED, UNKNOWN, ABN, EMAIL, TELEPHONE, BPAY, ORG_ID]

numberstringrequired
addressstring
referencestring
directionThirdPartyDirection (string)

Possible values: [PAYEE, PAYER, BOTH, UNKNOWN]

descriptionstring

the description of the transaction

categorystring

the transaction business category

subcategorystring

the transaction business sub category

budgetCategoryBudgetCategory (string)

the transaction budget category

Possible values: [INCOME, TRANSPORTATION, PERSONAL_DEVELOPMENT, MEDICAL_OR_HEALTHCARE, ENTERTAINMENT, HOUSING, FOOD, CHILDREN, INSURANCE, GIFTS, BILLS, PERSONAL_CARE, PETS, GOALS, DEBT, OTHER]

budgetSubcategorystring

the transaction budget sub category

frequencyFrequency (string)

Possible values: [YEAR, BIYEAR, QUARTER, MONTH, FORTNIGHT, WEEK, WEEKEND, BUSINESS, DAY]

Transaction
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "type": "CREDIT",
  "subtype": "DIRECTDEBIT",
  "status": "PENDING",
  "amount": {
    "amount": 123.45,
    "currency": "USD, EUR, AUD, NZD"
  },
  "fee": {
    "amount": 123.45,
    "currency": "USD, EUR, AUD, NZD"
  },
  "balance": {
    "amount": 123.45,
    "currency": "USD, EUR, AUD, NZD"
  },
  "original": {
    "amount": 123.45,
    "currency": "USD, EUR, AUD, NZD"
  },
  "exchangeRate": 123.45,
  "datetime": "2018-09-15T15:53:00Z",
  "externalId": "string",
  "code": "string",
  "thirdParty": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "accountNumber": {
      "scheme": "SORTCODE",
      "number": "string"
    },
    "address": "string",
    "reference": "string",
    "direction": "PAYEE"
  },
  "description": "string",
  "category": "string",
  "subcategory": "string",
  "budgetCategory": "INCOME",
  "budgetSubcategory": "string",
  "frequency": "YEAR"
}