Getting Started
Learn moreServices status
v1.1.1
OAS 3.0.0

Events API

Ockto OpenBanking Events API

Client Libraries
Curl Shell

Transactions Categorisation

​
Transactions Categorisation Operations

/TRANSACTIONS_PER_ACCOUNT

​
Body
application/json
  • detail-type
    const: 
    TRANSACTIONS_PER_ACCOUNT
    required
    • TRANSACTIONS_PER_ACCOUNT
  • source
    Type:string
    required
  • detail
    Type:object
    required
Responses
  • application/json
  • application/json
Request Example forPUT/TRANSACTIONS_PER_ACCOUNT
curl /TRANSACTIONS_PER_ACCOUNT \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "detail-type": "TRANSACTIONS_PER_ACCOUNT",
  "source": "",
  "detail": {
    "data": [
      null
    ],
    "meta": {
      "correlationId": "05a52548-b85a-5047-9d7c-00c9d231c144",
      "provider": "",
      "transactionSetId": "",
      "iban": "",
      "accountName": "",
      "pageIndex": 1,
      "firstPage": true,
      "lastPage": true,
      "force": true,
      "providerAccountId": "",
      "tenantUserId": "",
      "ownAccounts": [
        {
          "providerAccountId": "",
          "customerAccountNumber": ""
        }
      ],
      "accountBalances": [
        {
          "balanceAmount": "",
          "currency": "",
          "balanceType": "current",
          "lastChangeDateTime": ""
        }
      ],
      "dataLocation": {
        "resource": "s3",
        "bucketName": "",
        "objectKey": ""
      },
      "encryption": {
        "bufferFormat": "JSON",
        "encryptionContext": {
          "ANY_ADDITIONAL_PROPERTY": ""
        }
      }
    }
  }
}'

{
  "source": "…",
  "detail-type": "TRANSACTIONS_PER_ACCOUNT_ERROR",
  "detail": {
    "meta": {
      "correlationId": "05a52548-b85a-5047-9d7c-00c9d231c144",
      "tenantUserId": "05a52548-b85a-5047-9d7c-00c9d231c144",
      "userId": "05a52548-b85a-5047-9d7c-00c9d231c144",
      "tenantId": "…",
      "tenantAppId": "…"
    },
    "data": {
      "type": "VALIDATION_ERROR",
      "message": "…",
      "details": [
        "…"
      ]
    }
  }
}

Error event

Data Retention (Collapsed)

​
Data Retention Operations

User Categorisation Rules (Collapsed)

​
User Categorisation Rules Operations

Models