Open Banking

List open banking transactions

get

Lists open banking transactions with pagination

Query parameters

cursorstringOptional

Cursor for pagination

limitinteger · int64 · min: 1 · max: 100Optional

Maximum number of items to return

Example: 20

Responses

200

OK

application/json

default

Error

application/problem+json

get

/api/open-banking/transactions

HTTPcURLJavaScriptPython

GET /api/open-banking/transactions HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "items": [
    {
      "amount": 99.99,
      "createdAt": "2023-11-21T02:00:54.465Z",
      "currency": "EUR",
      "iban": "text",
      "id": "obt_550e8400-e29b-41d4-a716-446655440000",
      "metadata": "text",
      "modifiedAt": "2023-11-21T02:00:54.465Z",
      "sender": {
        "email": "[email protected]",
        "name": "Joe Doe"
      },
      "status": "PENDING",
      "successUrl": "text"
    }
  ],
  "nextCursor": "text"
}

Create open banking transaction

post

Creates a new open banking transaction

Body

application/json

Open banking transaction creation data

amountnumber · decimal · min: 0.01Required

Transaction amount in EUR

Example: 99.99

metadatastringOptional

Optional metadata (recommended JSON format)

successUrlstring · uri · min: 1Required

Redirect URL on successful transaction

Responses

200

OK

application/json

default

Error

application/problem+json

post

/api/open-banking/transactions

HTTPcURLJavaScriptPython

POST /api/open-banking/transactions HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "amount": 99.99,
  "metadata": "text",
  "sender": {
    "email": "[email protected]",
    "name": "Joe Doe"
  },
  "successUrl": "https://example.com"
}

{
  "id": "obt_550e8400-e29b-41d4-a716-446655440000",
  "url": "https://app.com/api/open-banking/transactions/widget/1ab"
}

Get open banking transaction

get

Retrieves an open banking transaction by ID

Path parameters

openBankingTransactionIdstringRequired

open banking transaction ID

Responses

200

OK

application/json

default

Error

application/problem+json

get

/api/open-banking/transactions/{openBankingTransactionId}

HTTPcURLJavaScriptPython

GET /api/open-banking/transactions/{openBankingTransactionId} HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "amount": 99.99,
  "createdAt": "2023-11-21T02:00:54.465Z",
  "currency": "EUR",
  "iban": "text",
  "id": "obt_550e8400-e29b-41d4-a716-446655440000",
  "metadata": "text",
  "modifiedAt": "2023-11-21T02:00:54.465Z",
  "sender": {
    "email": "[email protected]",
    "name": "Joe Doe"
  },
  "status": "PENDING",
  "successUrl": "text"
}