v0.0.9
OpenAPI 3.1.1

Accounts - API definition

Accounts - API definition

Server:https://api.acc.ockto.cloud/open-banking/sandbox/ais/accounts
Client Libraries

PSD2 - ACCOUNTS (Collapsed)

​

Get list of accounts belonging to the PSU

​

Get a list of accounts for the PSU doing this call (indicated by the JWT token).

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/
curl https://api.acc.ockto.cloud/open-banking/sandbox/ais/accounts/ \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": [
    {
      "accountId": "4e054abb-e8e9-43e8-bb65-c5c86720a231",
      "consentId": "f3cb5c80-6520-4bf7-b02b-593db8d1ad5a",
      "currency": "EUR",
      "providerAccountId": "8kg6zzydhdbss_YComVjiH8JL",
      "consentType": "AIS",
      "name": "D.L. PERSON",
      "aisStatus": "RISK_OK",
      "customerAccountNumber": "NLXXRABO03500XXXXX",
      "balances": [
        {
          "lastChangeDateTime": "2020-03-04T10:04:54.028Z",
          "currency": "EUR",
          "balanceType": "current",
          "balanceAmount": "1908.44"
        }
      ],
      "active": true,
      "consentStatus": "VALID",
      "userId": "14dd3422-fbd1-4254-8a68-d4bbf59f24dd",
      "provider": "RABO",
      "region": "NL",
      "iban": "NLXXRABO03500XXXXX",
      "type": "iban",
      "consentCreated": "2020-03-04T09:59:04.450Z",
      "lastUpdated": "2020-03-04T10:04:54.135Z",
      "created": "2020-02-17T09:04:24.668Z"
    }
  ],
  "pagination": {
    "next": {},
    "prev": {}
  }
}

Get account

​

Returns the account resource matching the given account id and PSU (indicated in the JWT token)

Path Parameters

  • Resource identification of the generated accounts resource.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/{accountId}
curl 'https://api.acc.ockto.cloud/open-banking/sandbox/ais/accounts/{accountId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "accountId": "4e054abb-e8e9-43e8-bb65-c5c86720a231",
  "consentId": "f3cb5c80-6520-4bf7-b02b-593db8d1ad5a",
  "currency": "EUR",
  "providerAccountId": "8kg6zzydhdbss_YComVjiH8JL",
  "consentType": "AIS",
  "name": "D.L. PERSON",
  "aisStatus": "RISK_OK",
  "customerAccountNumber": "NLXXRABO03500XXXXX",
  "balances": [
    {
      "lastChangeDateTime": "2020-03-04T10:04:54.028Z",
      "currency": "EUR",
      "balanceType": "current",
      "balanceAmount": "1908.44"
    }
  ],
  "active": true,
  "consentStatus": "VALID",
  "userId": "14dd3422-fbd1-4254-8a68-d4bbf59f24dd",
  "provider": "RABO",
  "region": "NL",
  "iban": "NLXXRABO03500XXXXX",
  "type": "iban",
  "consentCreated": "2020-03-04T09:59:04.450Z",
  "lastUpdated": "2020-03-04T10:04:54.135Z",
  "created": "2020-02-17T09:04:24.668Z"
}

Refresh the user's accounts via the linked provider(s)

​

Initiates one or more asynchronous calls to the provider(s) to obtain the latest accounts for the PSU.

Responses

  • OK

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/refresh
curl https://api.acc.ockto.cloud/open-banking/sandbox/ais/accounts/refresh \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Refresh the user's account via the linked provider

​

Initiates a synchronous call to the provider to obtain the latest accounts for the PSU.

Path Parameters

  • Resource identification of the generated accounts resource.

Responses

  • OK

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/{accountId}/refresh
curl 'https://api.acc.ockto.cloud/open-banking/sandbox/ais/accounts/{accountId}/refresh' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Models

We have a new documentation site with more integration guidance & a rich knowledge base Visit the new Open Banking documentation