v0.0.9
OpenAPI 3.1.1

Transactions - API definition

Transactions - API definition

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

PSD2 - TRANSACTIONS (Collapsed)

​
PSD2 - TRANSACTIONS Operations

Get list of transactions

​

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

Query Parameters

  • startAt
    Type: string

    Represents the start timestamp for searching and retrieving transactions.

  • endAt
    Type: string

    Represents the end timestamp for searching and retrieving transactions.

  • offset
    Type: string

    Represents the start offset from which to retrieve transactions.

  • limit
    Type: integer
    max:  
    1000

    Represents the maximum number of transactions to retrieve.

  • accountId[]
    Type: array of string

    Account identifier to retrieve the transactions for one or more specific accounts.

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/transactions/ \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "transactionId": "05a52548-b85a-5047-9d7c-00c9d231c144",
      "valueDate": "2013-11-07",
      "debtorAccount": {
        "counterparty": "D.L. PERSON",
        "currency": "EUR",
        "iban": "NLXXRABO03500XXXXX"
      },
      "lastUpdated": "2021-02-09T15:07:12.936Z",
      "accountId": "975c8e38-3b89-4ca5-87d7-6103aab74a65",
      "providerAccountId": "8kg6jxyz_YComVjiH8JL",
      "balanceBefore": {
        "currency": "EUR",
        "amount": "1000.0"
      },
      "balanceAfter": {
        "currency": "EUR",
        "amount": "900.0"
      },
      "transactionAmount": {
        "currency": "EUR",
        "amount": "-100.0"
      },
      "status": "booked",
      "created": "2021-02-09T15:07:12.936Z",
      "creditorAccount": {
        "counterparty": "Basic John",
        "iban": "NLXXRABO31537XXXXX"
      },
      "bookingDate": "2013-11-06T23:05:38.733072Z",
      "userId": "6b991b9f-9236-44d5-b93b-c7d24722a5fb",
      "provider": "RABO",
      "region": "NL",
      "description": "Sparen                             Transactiereferentie:",
      "paymentType": "ScheduledPayment"
    }
  ],
  "pagination": {
    "next": {},
    "prev": {}
  }
}

OK

Get transaction

​

Returns the transaction resource matching the given transaction id

Path Parameters

  • transactionId
    Type: string
    required

    Resource identification of the transaction 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/{transactionId}
curl 'https://api.acc.ockto.cloud/open-banking/sandbox/ais/transactions/{transactionId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "transactionId": "05a52548-b85a-5047-9d7c-00c9d231c144",
  "valueDate": "2013-11-07",
  "debtorAccount": {
    "counterparty": "D.L. PERSON",
    "currency": "EUR",
    "iban": "NLXXRABO03500XXXXX"
  },
  "lastUpdated": "2021-02-09T15:07:12.936Z",
  "accountId": "975c8e38-3b89-4ca5-87d7-6103aab74a65",
  "providerAccountId": "8kg6jxyz_YComVjiH8JL",
  "balanceBefore": {
    "currency": "EUR",
    "amount": "1000.0"
  },
  "balanceAfter": {
    "currency": "EUR",
    "amount": "900.0"
  },
  "transactionAmount": {
    "currency": "EUR",
    "amount": "-100.0"
  },
  "status": "booked",
  "created": "2021-02-09T15:07:12.936Z",
  "creditorAccount": {
    "counterparty": "Basic John",
    "iban": "NLXXRABO31537XXXXX"
  },
  "bookingDate": "2013-11-06T23:05:38.733072Z",
  "userId": "6b991b9f-9236-44d5-b93b-c7d24722a5fb",
  "provider": "RABO",
  "region": "NL",
  "description": "Sparen                             Transactiereferentie:",
  "paymentType": "ScheduledPayment"
}

OK

Get transactions status

​

Get status of the transactions for the PSU doing this call (indicated by the JWT token). Will throw a 404 if the retrieval is not started yet.

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/status
curl https://api.acc.ockto.cloud/open-banking/sandbox/ais/transactions/status \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

[
  {
    "accountId": 12345,
    "status": "COMPLETED",
    "lastUpdated": "2020-12-12T14:33:22.237Z"
  }
]

OK

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

​

Initiates one or more asynchronous calls to the provider(s) to obtain the latest transactions based on the PSU identified in the JWT

Responses

  • 202

    Resource update accepted

  • 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/transactions/refresh \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Resource update accepted

Models

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