Skip to main content

classifierTransaction

idstring

ID of the transaction (Will be replayed in the classified transactions)

accountstring<uuid>

The wych account that this transaction belongs to (Optional)

typestring

Possible values: [CREDIT, DEBIT]

statusstring

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
namestring
accountNumber objectrequired
schemestringrequired

Possible values: [SORTCODE, IBAN, PAN, BIC, BBAN_SE, BBAN_DK, BBAN_NO, BECS, BSB_NO]

numberstringrequired
addressstring
referencestring
descriptionstring

the description of the transaction

categorystring

the transaction category

subcategorystring

the transaction sub category

classifierTransaction
{
  "id": "string",
  "account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "CREDIT",
  "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": {
    "name": "string",
    "accountNumber": {
      "scheme": "SORTCODE",
      "number": "string"
    },
    "address": "string",
    "reference": "string"
  },
  "description": "string",
  "category": "string",
  "subcategory": "string"
}