{
  "openapi": "3.1.1",
  "info": {
    "title": "Aritma Banking API",
    "description": "## API versioning\r\n\r\nOver time there will be introduced changes to the API as we continuously introduce improvements.\r\nYou have the option to use a specific version or the most recent version, supported versions are\r\navailable in the response header `api-supported-versions`.\r\n\r\nUse a specific version of the API by specifying the api-version header, for example `api-version: 1.0`.\r\nIf you don't specify the header, the latest version will be used.\r\nIf a version has been scheduled to be removed, it will be reported through the api-deprecated-versions header, for example `api-deprecated-versions: 1.0, 1.1`.\r\n\r\n## Idempotency\r\n\r\nThe API supports idempotency for safely retrying POST requests without accidentally performing the operation twice.\r\nTo perform an idempotent request, specify the `Idempotency-Key: UUID` header with a value on UUID format,\r\nexample: `Idempotency-Key: 5bfa15da-0969-46a3-820d-be0ec7a16c24`.\r\n\r\nThe idempotency works by storing the status code and body of the first response made for the idempotency key for a short timespan,\r\nregardless of whether if succeeds or fails. Subsequent request with the same key returns the response of the previous response.\r\nThe presence of response header `Idempotent-Replayed: true` indicates that a previous response has been returned.\r\nNote that the replayed responses for created resources would change from status `201` to `200` ok,\r\nindicating that no resource was created.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://banking.zdata.io/api/"
    }
  ],
  "paths": {
    "/accounts/{id}": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get account",
        "description": "The account-id is retrieved by using the \"Get accounts\" call.",
        "operationId": "GetAccount",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The id of the account.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "3dc3d5b3-7023-4848-9853-f5400a64e81f"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU, it should only be set if this request was actively initiated by the PSU.\r\nMost operations have request limits that apply when a user is not present.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Account not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      },
      "delete": {
        "tags": [
          "Accounts"
        ],
        "summary": "Delete account",
        "operationId": "DeleteAccount",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The id of the account to delete.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "3dc3d5b3-7023-4848-9853-f5400a64e81f"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU, it should only be set if this request was actively initiated by the PSU.\r\nMost operations have request limits that apply when a user is not present.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Account not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/accounts": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get accounts",
        "operationId": "GetAccounts",
        "parameters": [
          {
            "name": "withBalance",
            "in": "query",
            "description": "If the account balance should be included.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "bban",
            "in": "query",
            "description": "The Basic Bank Account Number (BBAN) used to filter accounts.",
            "schema": {
              "type": "string"
            },
            "example": "12345612345678"
          },
          {
            "name": "iban",
            "in": "query",
            "description": "The International Bank Account Number (IBAN) used to filter accounts.",
            "schema": {
              "type": "string"
            },
            "example": "FR7612345987650123456789014"
          },
          {
            "name": "search",
            "in": "query",
            "description": "Search for an account matching the phrase.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "A reference to a specific page.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU, it should only be set if this request was actively initiated by the PSU.\r\nMost operations have request limits that apply when a user is not present.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountsResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Account not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/accounts/{id}/transactions": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get transactions",
        "operationId": "GetTransactions",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The id of the account.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "3dc3d5b3-7023-4848-9853-f5400a64e81f"
          },
          {
            "name": "dateFrom",
            "in": "query",
            "description": "Starting date (inclusive) of the transactions.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "2026-01-01T00:00:00Z"
          },
          {
            "name": "dateTo",
            "in": "query",
            "description": "End date (inclusive) of the transaction list, default is \"now\" if not given.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bookingStatus",
            "in": "query",
            "description": "The booking status to include.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/BookingStatus"
            }
          },
          {
            "name": "transactionType",
            "in": "query",
            "description": "The kind of transaction.",
            "schema": {
              "$ref": "#/components/schemas/TransactionType"
            }
          },
          {
            "name": "transactionSource",
            "in": "query",
            "description": "The source of the transaction.",
            "schema": {
              "$ref": "#/components/schemas/TransactionSource"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "A reference to a specific page.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU, it should only be set if this request was actively initiated by the PSU.\r\nMost operations have request limits that apply when a user is not present.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransactionsResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Account not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/accounts/{accountId}/transactions/{id}": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get transaction details",
        "operationId": "GetTransactionDetails",
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "description": "The id of the account.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "3dc3d5b3-7023-4848-9853-f5400a64e81f"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The id of the transaction.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "3dc3d5b3-7023-4848-9853-f5400a64e80f"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "A reference to a specific page.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU, it should only be set if this request was actively initiated by the PSU.\r\nMost operations have request limits that apply when a user is not present.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransactionDetailsResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Account not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/accounts/{id}/parameters": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get account parameters",
        "operationId": "GetAccountParameters",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The id of the account.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "3dc3d5b3-7023-4848-9853-f5400a64e81f"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU, it should only be set if this request was actively initiated by the PSU.\r\nMost operations have request limits that apply when a user is not present.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountParametersResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Account not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/accounts/{id}/balances": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Get account balances",
        "operationId": "GetAccountBalances",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The id of the account.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "3dc3d5b3-7023-4848-9853-f5400a64e81f"
          },
          {
            "name": "dateFrom",
            "in": "query",
            "description": "Starting date (inclusive) from which to return balances.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "A reference to a specific page.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "type",
            "in": "query",
            "description": "The type of balance to include, when not set all types will be returned.",
            "schema": {
              "$ref": "#/components/schemas/BalanceType"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU, it should only be set if this request was actively initiated by the PSU.\r\nMost operations have request limits that apply when a user is not present.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountBalanceResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Account not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/banks": {
      "get": {
        "tags": [
          "Banks"
        ],
        "summary": "Get banks",
        "description": "This endpoint does not require authentication.",
        "operationId": "GetBanks",
        "parameters": [
          {
            "name": "countryCode",
            "in": "query",
            "description": "Limit the results to a specific ISO 3166-1 Alpha-2 country code.",
            "schema": {
              "maxLength": 2,
              "minLength": 2,
              "type": "string"
            },
            "example": "NO"
          },
          {
            "name": "channels",
            "in": "query",
            "description": "Limit the results to one or more specific channels (e.g. \"psd2\", \"openbanking\").",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "includeAdditionalInformation",
            "in": "query",
            "description": "Set to true if additional information about the bank integration should be included. Used for documentation purposes.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BanksSearchResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/banks/{bankId}": {
      "get": {
        "tags": [
          "Banks"
        ],
        "summary": "Get bank",
        "operationId": "GetBank",
        "parameters": [
          {
            "name": "bankId",
            "in": "path",
            "description": "Unique identifier of the bank.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "89F7F63B-67C0-4F70-A6BE-898BC211DCA0"
          },
          {
            "name": "channels",
            "in": "query",
            "description": "Limit the results to one or more specific channels (e.g. \"psd2\", \"openbanking\").",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "includeAdditionalInformation",
            "in": "query",
            "description": "Set to true if additional information about the bank integration should be included. Used for documentation purposes.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BankResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/consents": {
      "post": {
        "tags": [
          "Consents"
        ],
        "summary": "Create consent",
        "description": "Returns a redirect URL for the PSU to authorise the consent with the chosen bank.",
        "operationId": "CreateConsent",
        "parameters": [
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateConsentRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateConsentResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      },
      "get": {
        "tags": [
          "Consents"
        ],
        "summary": "Get consents",
        "operationId": "GetConsents",
        "parameters": [
          {
            "name": "cursor",
            "in": "query",
            "description": "A reference to a specific page.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetConsentsResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Consent not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/consents/{id}/refresh": {
      "put": {
        "tags": [
          "Consents"
        ],
        "summary": "Refresh consent",
        "description": "Returns a redirect URL for the PSU to re-authorise an expiring consent.",
        "operationId": "RefreshConsent",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RefreshConsentRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateConsentResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/consents/{id}": {
      "get": {
        "tags": [
          "Consents"
        ],
        "summary": "Get consent",
        "operationId": "GetConsent",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Resource identifier of the consent.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "1E5EFC3B-635E-4973-A605-41D7F0D6D7B3"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetConsentResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Consent not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      },
      "delete": {
        "tags": [
          "Consents"
        ],
        "summary": "Delete consent",
        "description": "The PSU can also withdraw the consent independently at any point.",
        "operationId": "DeleteConsent",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Resource identifier of the consent to delete.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "1E5EFC3B-635E-4973-A605-41D7F0D6D7B3"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Consent not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/bulk-payments/{paymentProduct}": {
      "post": {
        "tags": [
          "Payments"
        ],
        "summary": "Initiate bulk payment",
        "description": "All payments in the bulk must share the same debtor account (or creditor account for direct-debit payments) and requested execution date.",
        "operationId": "InitiatePayment",
        "parameters": [
          {
            "name": "TPP-Redirect-URI",
            "in": "header",
            "description": "The URI to redirect the PSU to after authorisation.",
            "schema": {
              "type": "string",
              "format": "uri"
            }
          },
          {
            "name": "paymentProduct",
            "in": "path",
            "description": "The payment product type.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/PaymentProduct"
            },
            "example": "credit-transfer"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Bulk payment details including debtor account (or creditor account for direct-debit payments) and payment lines.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PaymentRequestBulk"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InitiateBulkPaymentResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#bad-request",
                  "title": "Bad request",
                  "status": 400,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01",
                  "errors": {
                    "Foo": "Foo must be specified",
                    "Bar": "Bar is not valid"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Payment not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      },
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "Get bulk payments",
        "operationId": "GetBulkPayments",
        "parameters": [
          {
            "name": "paymentProduct",
            "in": "path",
            "description": "The payment product type.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/PaymentProduct"
            },
            "example": "credit-transfer"
          },
          {
            "name": "createdFrom",
            "in": "query",
            "description": "Only payments created after this date will be fetched.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "description": "Only payments created before this date will be fetched, should be a later date than createdFrom.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "updatedFrom",
            "in": "query",
            "description": "Only payments updated after this date will be fetched, payments that have never been updated will also be fetched.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "updatedTo",
            "in": "query",
            "description": "Only payments updated before this date will be fetched, payments that have never been updated will also be fetched, should be a later date than updatedFrom if specified.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter payments by transaction status.",
            "schema": {
              "$ref": "#/components/schemas/TransactionStatus"
            }
          },
          {
            "name": "accountId",
            "in": "query",
            "description": "Resource identifier of the account to get payments for.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "A reference to a specific page.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetBulkPaymentsResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Payment not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/bulk-payments/{paymentProduct}/{paymentId}": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "Get bulk payment information",
        "operationId": "GetBulkPaymentInformation",
        "parameters": [
          {
            "name": "paymentProduct",
            "in": "path",
            "description": "The payment product type.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/PaymentProduct"
            },
            "example": "credit-transfer"
          },
          {
            "name": "paymentId",
            "in": "path",
            "description": "Resource identifier of the bulk payment initiation.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "p1b52718ebabcd14affa29261a32d864557"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "A reference to a specific page.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetBulkPaymentResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Payment not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/payments/{paymentProduct}/{paymentId}/status": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "Get payment status",
        "operationId": "GetPaymentStatus",
        "parameters": [
          {
            "name": "paymentProduct",
            "in": "path",
            "description": "The payment product type.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/PaymentProduct"
            },
            "example": "credit-transfer"
          },
          {
            "name": "paymentId",
            "in": "path",
            "description": "Resource identifier of the payment initiation.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InitiatePaymentResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Payment not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/payments/{paymentProduct}/{paymentId}/authorizations": {
      "post": {
        "tags": [
          "Payments"
        ],
        "summary": "Start authorisation",
        "description": "The PSU will be redirected to complete Strong Customer Authentication (SCA).",
        "operationId": "StartAuthorization",
        "parameters": [
          {
            "name": "paymentProduct",
            "in": "path",
            "description": "The payment product type.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/PaymentProduct"
            },
            "example": "credit-transfer"
          },
          {
            "name": "paymentId",
            "in": "path",
            "description": "Resource identifier of the payment initiation.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          {
            "name": "TPP-Redirect-URI",
            "in": "header",
            "description": "The URI to redirect the PSU to after authorisation.",
            "schema": {
              "type": "string",
              "format": "uri"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Authentication method selection.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SelectPsuAuthenticationMethod"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateAuthorizationResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Payment not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/payments/{paymentProduct}/{paymentId}/authorizations/{authorizationId}": {
      "put": {
        "tags": [
          "Payments"
        ],
        "summary": "Update authorisation",
        "description": "Called after the PSU has completed the redirect SCA flow.",
        "operationId": "UpdateAuthorization",
        "parameters": [
          {
            "name": "paymentProduct",
            "in": "path",
            "description": "The payment product type.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/PaymentProduct"
            },
            "example": "credit-transfer"
          },
          {
            "name": "paymentId",
            "in": "path",
            "description": "Resource identifier of the payment initiation.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          {
            "name": "authorizationId",
            "in": "path",
            "description": "Resource identifier of the authorisation sub-resource.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "auth9000"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateAuthorizationResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Payment not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "User access": [
              "services.banking"
            ]
          }
        ]
      }
    },
    "/payments/{paymentProduct}/{paymentId}": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "Get payment information",
        "operationId": "GetPaymentInformation",
        "parameters": [
          {
            "name": "paymentProduct",
            "in": "path",
            "description": "The payment product type.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/PaymentProduct"
            },
            "example": "credit-transfer"
          },
          {
            "name": "paymentId",
            "in": "path",
            "description": "Resource identifier of the payment initiation.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "A reference to a specific page.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetPaymentResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Payment not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/signing-baskets/{basketId}": {
      "get": {
        "tags": [
          "SigningBaskets"
        ],
        "summary": "Get signing basket",
        "operationId": "GetSigningBasket",
        "parameters": [
          {
            "name": "basketId",
            "in": "path",
            "description": "Resource identifier of the signing basket.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "4f0d36c610d44e60af3c244259aa7779"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SigningBasketResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#bad-request",
                  "title": "Bad request",
                  "status": 400,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01",
                  "errors": {
                    "Foo": "Foo must be specified",
                    "Bar": "Bar is not valid"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Signing basket not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      },
      "delete": {
        "tags": [
          "SigningBaskets"
        ],
        "summary": "Cancel signing basket",
        "operationId": "CancelSigningBasket",
        "parameters": [
          {
            "name": "basketId",
            "in": "path",
            "description": "Resource identifier of the signing basket to cancel.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "4f0d36c610d44e60af3c244259aa7779"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Signing basket not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/signing-baskets/{basketId}/status": {
      "get": {
        "tags": [
          "SigningBaskets"
        ],
        "summary": "Get signing basket status",
        "operationId": "GetSigningBasketStatus",
        "parameters": [
          {
            "name": "basketId",
            "in": "path",
            "description": "Resource identifier of the signing basket.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "4f0d36c610d44e60af3c244259aa7779"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SigningBasketStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#bad-request",
                  "title": "Bad request",
                  "status": 400,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01",
                  "errors": {
                    "Foo": "Foo must be specified",
                    "Bar": "Bar is not valid"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Signing basket not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/signing-baskets/{basketId}/authorizations": {
      "post": {
        "tags": [
          "SigningBaskets"
        ],
        "summary": "Start basket authorisation",
        "description": "The PSU will be redirected to complete SCA for all payments in the basket.",
        "operationId": "StartSigningBasketAuthorization",
        "parameters": [
          {
            "name": "basketId",
            "in": "path",
            "description": "Resource identifier of the signing basket.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "4f0d36c610d44e60af3c244259aa7779"
          },
          {
            "name": "TPP-Redirect-URI",
            "in": "header",
            "description": "The URI to redirect the PSU to after authorisation.",
            "schema": {
              "type": "string",
              "format": "uri"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Authentication method selection.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SelectPsuAuthenticationMethod"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateAuthorizationResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Signing basket not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    },
    "/signing-baskets/{basketId}/authorizations/{authorizationId}": {
      "put": {
        "tags": [
          "SigningBaskets"
        ],
        "summary": "Update basket authorisation",
        "description": "Called after the PSU has completed the redirect SCA flow.",
        "operationId": "UpdateSigningBasketAuthorization",
        "parameters": [
          {
            "name": "basketId",
            "in": "path",
            "description": "Resource identifier of the signing basket.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "4f0d36c610d44e60af3c244259aa7779"
          },
          {
            "name": "authorizationId",
            "in": "path",
            "description": "Resource identifier of the authorisation sub-resource.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "auth9000"
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateAuthorizationResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Signing basket not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "User access": [
              "services.banking"
            ]
          }
        ]
      }
    },
    "/signing-baskets": {
      "post": {
        "tags": [
          "SigningBaskets"
        ],
        "summary": "Create signing basket",
        "description": "The basket can contain bulk payments and individual payment lines with different authorisation\r\nrequirements. Payments are exported as soon as their requirements are fulfilled.",
        "operationId": "CreateSigningBasket",
        "parameters": [
          {
            "name": "TPP-Redirect-URI",
            "in": "header",
            "description": "The URI to redirect the PSU to after authorisation.",
            "schema": {
              "type": "string",
              "format": "uri"
            }
          },
          {
            "name": "PSU-IP-Address",
            "in": "header",
            "description": "IP Address of the PSU.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Consent-ID",
            "in": "header",
            "description": "The consent id. Should be set unless a specific Subscription-Id is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Channel-Type",
            "in": "header",
            "description": "The banking channel.",
            "schema": {
              "$ref": "#/components/schemas/BankingChannel"
            }
          },
          {
            "name": "Subscription-Id",
            "in": "header",
            "description": "Id of the subscription to use. Only supported for Channel-Type `openBanking`.",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Resource-Group-Name",
            "in": "header",
            "description": "Name of the resource group to use in the specified subscription. Only supported for Channel-Type `openBanking`",
            "schema": {
              "pattern": "^[A-Za-z0-9_-]+$",
              "type": "string"
            }
          },
          {
            "name": "Scopes",
            "in": "header",
            "description": "Resource scopes to use, mutually exclusive with `subscriptionId`.\r\n- `/`: Use all resources available.\r\n- `/subscriptions/7fdf00601dfb`: Use all resources in subscription 7fdf00601dfb.\r\n- `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all resources within subscription 7fdf00601dfb and resource-group my-company.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
            },
            "example": "/subscriptions/7fdf00601dfb/resource-groups/my-company"
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The signing basket containing the payment identifiers to group.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SigningBasket"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SigningBasketResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#bad-request",
                  "title": "Bad request",
                  "status": 400,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01",
                  "errors": {
                    "Foo": "Foo must be specified",
                    "Bar": "Bar is not valid"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
                  "title": "Access unauthorized",
                  "status": 401,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-forbidden",
                  "title": "Access was forbidden",
                  "status": 403,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://developer.aritma.com/apis/banking/development/errors/#not-found",
                  "title": "Signing basket not found",
                  "status": 404,
                  "detail": "",
                  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
                }
              }
            }
          }
        },
        "security": [
          {
            "Api access": [
              "services.banking",
              "api"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AccountBalance": {
        "type": "object",
        "properties": {
          "balanceAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "balanceType": {
            "$ref": "#/components/schemas/BalanceType"
          },
          "referenceDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "Indicates the date of the balance",
            "format": "date-time",
            "example": "2020-01-01T13:00:00.999+00:00"
          },
          "lastChangeDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "This indicates if the balance has changed, an account balance may change during one day.",
            "format": "date-time",
            "example": "2020-01-01T13:00:00.999+00:00"
          }
        },
        "additionalProperties": false,
        "description": "Balance of the account"
      },
      "AccountBalanceResponse": {
        "required": [
          "account"
        ],
        "type": "object",
        "properties": {
          "account": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "accountBalances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountBalance"
            },
            "description": "List of account balances."
          },
          "_links": {
            "$ref": "#/components/schemas/Links"
          }
        },
        "additionalProperties": false,
        "description": "Response containing balance data for an account."
      },
      "AccountNumbers": {
        "type": "object",
        "properties": {
          "iban": {
            "pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}",
            "type": [
              "null",
              "string"
            ],
            "description": "IBAN of the account",
            "example": "FR7612345987650123456789014"
          },
          "bban": {
            "pattern": "[a-zA-Z0-9]{1,30}",
            "type": [
              "null",
              "string"
            ],
            "description": "BBAN of the account - ISO 20022",
            "example": "BARC12345612345678"
          },
          "other": {
            "$ref": "#/components/schemas/GenericAccountDto"
          },
          "currency": {
            "pattern": "[A-Z]{3}",
            "type": [
              "null",
              "string"
            ],
            "description": "Currency code - ISO 4217",
            "example": "EUR"
          }
        },
        "additionalProperties": false
      },
      "AccountOwnerDto": {
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 70,
            "type": [
              "null",
              "string"
            ],
            "description": "Account owner name",
            "example": "Corporation AB"
          },
          "role": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Role of the party in relation to the account.",
            "example": "owner"
          },
          "postalAddress": {
            "$ref": "#/components/schemas/PostalAddressDto"
          },
          "organisationId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Organisation identification.",
            "example": "699317284"
          }
        },
        "additionalProperties": false
      },
      "AccountParameters": {
        "type": "object",
        "properties": {
          "payments": {
            "$ref": "#/components/schemas/PaymentParameters"
          }
        },
        "additionalProperties": false,
        "description": "Parameters for an account."
      },
      "AccountParametersResponse": {
        "type": "object",
        "properties": {
          "account": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "parameters": {
            "$ref": "#/components/schemas/AccountParameters"
          }
        },
        "additionalProperties": false,
        "description": "Response containing configuration parameters for an account."
      },
      "AccountReference": {
        "type": "object",
        "properties": {
          "iban": {
            "pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}",
            "type": [
              "null",
              "string"
            ],
            "description": "IBAN of the account",
            "example": "FR7612345987650123456789014"
          },
          "bban": {
            "pattern": "[a-zA-Z0-9]{1,30}",
            "type": [
              "null",
              "string"
            ],
            "description": "BBAN of the account - ISO 20022",
            "example": "BARC12345612345678"
          },
          "other": {
            "$ref": "#/components/schemas/GenericAccountDto"
          },
          "currency": {
            "pattern": "[A-Z]{3}",
            "type": [
              "null",
              "string"
            ],
            "description": "Currency code - ISO 4217",
            "example": "EUR"
          },
          "pan": {
            "type": [
              "null",
              "string"
            ],
            "description": "Primary Account Number - ISO/IEC 7812",
            "example": "5409050000000000"
          },
          "maskedPan": {
            "type": [
              "null",
              "string"
            ],
            "description": "Masked Primary Account Number - ISO/IEC 7812",
            "example": "123456xxxxxx1234"
          },
          "msisdn": {
            "type": [
              "null",
              "string"
            ],
            "description": "Mobile phone number",
            "example": "+491701234567"
          }
        },
        "additionalProperties": false,
        "description": "Account reference"
      },
      "AccountReport": {
        "type": "object",
        "properties": {
          "booked": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Transaction"
            },
            "description": "Booked transactions"
          },
          "pending": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Transaction"
            },
            "description": "Pending transactions",
            "example": []
          },
          "information": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Transaction"
            },
            "description": "Standing orders",
            "example": []
          },
          "_links": {
            "$ref": "#/components/schemas/Links"
          }
        },
        "additionalProperties": false
      },
      "AccountResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id of the account",
            "example": "67e98aeec65145888fefa7cb935c9197"
          },
          "iban": {
            "pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}",
            "type": [
              "null",
              "string"
            ],
            "description": "IBAN (International Bank Account Number) of the account",
            "example": "FR7612345987650123456789014"
          },
          "bban": {
            "pattern": "[a-zA-Z0-9]{1,30}",
            "type": [
              "null",
              "string"
            ],
            "description": "BBAN (Basic Bank Account Number) - ISO 20022",
            "example": "BARC12345612345678"
          },
          "other": {
            "$ref": "#/components/schemas/GenericAccountDto"
          },
          "bic": {
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}",
            "type": [
              "null",
              "string"
            ],
            "description": "BICFI",
            "example": "AAAADEBBXXX"
          },
          "currency": {
            "type": [
              "null",
              "string"
            ],
            "description": "ISO 4217 Alpha 3 currency code.",
            "example": "NOK"
          },
          "name": {
            "type": [
              "null",
              "string"
            ],
            "description": "Name of the account",
            "example": "Usage Account"
          },
          "displayName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Name of the account for use within online channels.",
            "example": "My usage account"
          },
          "status": {
            "$ref": "#/components/schemas/StatusType"
          },
          "ownerName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Name of the legal account owner.",
            "example": "Corporation AB"
          },
          "owner": {
            "$ref": "#/components/schemas/AccountOwnerDto"
          },
          "balances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountBalance"
            },
            "description": "Account balances"
          }
        },
        "additionalProperties": false,
        "description": "Account details as returned by the Account Information Service."
      },
      "AccountsResponse": {
        "type": "object",
        "properties": {
          "accounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountResponse"
            },
            "description": "List of account details."
          },
          "_links": {
            "$ref": "#/components/schemas/Links"
          }
        },
        "additionalProperties": false,
        "description": "Response containing a list of accounts."
      },
      "AdditionalInformation": {
        "type": "object",
        "properties": {
          "heading": {
            "type": "string"
          },
          "content": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "Address": {
        "required": [
          "country"
        ],
        "type": "object",
        "properties": {
          "streetName": {
            "maxLength": 70,
            "type": [
              "null",
              "string"
            ],
            "description": "Name of the street.",
            "example": "Storgata"
          },
          "buildingNumber": {
            "type": [
              "null",
              "string"
            ],
            "description": "Building number within the street.",
            "example": "56"
          },
          "postCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "Post code of the address.",
            "example": "0182"
          },
          "townName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Name of the town or city.",
            "example": "Oslo"
          },
          "country": {
            "minLength": 1,
            "pattern": "[A-Z]{2}",
            "type": "string",
            "description": "ISO 3166-1 Alpha-2 country code.",
            "example": "NO"
          }
        },
        "additionalProperties": false,
        "description": "Postal address."
      },
      "AmountDetail": {
        "type": "object",
        "properties": {
          "currency": {
            "type": [
              "null",
              "string"
            ],
            "description": "The three-letter currency code of the amount - ISO 4217",
            "example": "NOK"
          },
          "amount": {
            "pattern": "-?[0-9]{1,14}(\\.[0-9]{1,3})?",
            "type": [
              "null",
              "string"
            ],
            "description": "The amount value. Negative amounts are signed by minus. The decimal separator is a dot.\r\n            \r\n**Example:**\r\n* 0\r\n* 154\r\n* -1.75\r\n* 349.7\r\n* 3632.78",
            "example": "3632.78"
          },
          "sourceCurrency": {
            "pattern": "[A-Z]{3}",
            "type": [
              "null",
              "string"
            ],
            "description": "Currency from which an amount is to be converted in a currency conversion",
            "example": "EUR"
          },
          "exchangeRate": {
            "type": [
              "null",
              "number"
            ],
            "description": "Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency",
            "format": "double"
          },
          "unitCurrency": {
            "pattern": "[A-Z]{3}",
            "type": [
              "null",
              "string"
            ],
            "description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR",
            "example": "EUR"
          },
          "targetCurrency": {
            "pattern": "[A-Z]{3}",
            "type": [
              "null",
              "string"
            ],
            "description": "Currency into which an amount is to be converted in a currency conversion",
            "example": "EUR"
          },
          "quotationDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "Date at which an exchange rate is quoted",
            "format": "date-time"
          },
          "contractId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Unique identification to unambiguously identify the foreign exchange contract"
          }
        },
        "additionalProperties": false
      },
      "AmountDetails": {
        "type": "object",
        "properties": {
          "instructedAmount": {
            "$ref": "#/components/schemas/AmountDetail"
          },
          "transactionAmount": {
            "$ref": "#/components/schemas/AmountDetail"
          }
        },
        "additionalProperties": false
      },
      "BalanceType": {
        "enum": [
          "closingBooked",
          "openingBooked",
          "expected",
          "interimAvailable",
          "interimBooked",
          "forwardAvailable",
          "nonInvoiced"
        ],
        "type": "string",
        "description": "The type of balance",
        "example": "closingBooked",
        "x-enumDescriptions": {
          "closingBooked": "Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period. For card-accounts, this is composed of invoiced, but not yet paid entries. Most requests for balances of an account belonging to a private customer will include this balancetype.",
          "openingBooked": "Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.",
          "expected": "Balance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted. For card accounts, this is composed of invoiced, but not yet paid entries, not yet invoiced but already booked entries and pending item(not yet booked) Most requests for balances of an account belonging to a private customer will include this balancetype",
          "interimAvailable": "Available balance calculated in the course of the account servicer’s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. For card-accounts, this is composed of invoiced, but not yet paid entries and not yet invoiced but already booked entries",
          "interimBooked": "Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.",
          "forwardAvailable": "Forward available balance of money that is at the disposal of the account owner on the date specified.",
          "nonInvoiced": "Only for card accounts, to be checked yet."
        }
      },
      "BankConsentProperties": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Short text providing information about the property",
            "example": "Corporate bank id"
          },
          "type": {
            "$ref": "#/components/schemas/PropType"
          },
          "description": {
            "type": [
              "null",
              "string"
            ],
            "description": "Additional information about the property"
          },
          "enum": {
            "type": [
              "null",
              "array"
            ],
            "items": {},
            "description": "If specified, the property must be one of the specified values"
          },
          "pattern": {
            "type": [
              "null",
              "string"
            ],
            "description": "Regular expression",
            "example": "^[a-zA-Z][a-zA-Z]\\\\d{5}$"
          },
          "minimum": {
            "type": [
              "null",
              "number"
            ],
            "description": "Minimum value that is acceptable and valid for the input",
            "format": "double"
          },
          "maximum": {
            "type": [
              "null",
              "number"
            ],
            "description": "Maximum value that is acceptable and valid for the input",
            "format": "double"
          },
          "minLength": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The minimum number of characters the user can enter into an field",
            "format": "int32"
          },
          "maxLength": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The maximum number of characters the user can enter into an field",
            "format": "int32"
          },
          "errorMessage": {
            "type": [
              "null",
              "string"
            ],
            "description": "Error message in case of validation error",
            "example": "two letters followed by 5 digits."
          },
          "condition": {
            "$ref": "#/components/schemas/PropertyCondition"
          }
        },
        "additionalProperties": false
      },
      "BankConsentProperty": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Short text providing information about the property",
            "example": "Corporate bank id"
          }
        },
        "additionalProperties": false
      },
      "BankItem": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the bank",
            "example": "9FBEFB80-27E1-421F-A24F-467334007D39"
          },
          "bic": {
            "type": "string",
            "description": "BIC/SWIFT code of the bank",
            "example": "DNBANOKKXXX"
          },
          "name": {
            "type": "string",
            "description": "Name of the bank",
            "example": "DNB Bank ASA"
          },
          "countryCode": {
            "type": "string",
            "description": "ISO 3166-1 Alpha 2 country code",
            "example": "NO"
          },
          "channelType": {
            "$ref": "#/components/schemas/BankingChannel"
          },
          "consentProperties": {
            "type": [
              "null",
              "object"
            ],
            "additionalProperties": {
              "$ref": "#/components/schemas/BankConsentProperty"
            },
            "description": "Attributes that can be used when creating consents"
          },
          "logo": {
            "type": "string",
            "description": "Bank logo"
          },
          "additionalInformations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalInformation"
            },
            "description": "Additional information about the specific bank / integration.\r\nTypically used for documentation purposes."
          },
          "onboarding": {
            "$ref": "#/components/schemas/BankOnboardingDetails"
          }
        },
        "additionalProperties": false
      },
      "BankOnboardingDetails": {
        "type": "object",
        "properties": {
          "document": {
            "type": [
              "null",
              "string"
            ],
            "description": "Link to a document that describes the onboarding process for the bank."
          },
          "href": {
            "type": [
              "null",
              "string"
            ],
            "description": "Link to an external onboarding page that the PSU can be redirected to."
          }
        },
        "additionalProperties": false,
        "description": "Contains information related to onboarding against a specific bank."
      },
      "BankResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the bank",
            "example": "9FBEFB80-27E1-421F-A24F-467334007D39"
          },
          "bic": {
            "type": "string",
            "description": "BIC/SWIFT code of the bank",
            "example": "DNBANOKKXXX"
          },
          "name": {
            "type": "string",
            "description": "Name of the bank",
            "example": "DNB Bank ASA"
          },
          "countryCode": {
            "type": "string",
            "description": "ISO 3166-1 Alpha 2 country code",
            "example": "NO"
          },
          "channelType": {
            "$ref": "#/components/schemas/BankingChannel"
          },
          "consentProperties": {
            "type": [
              "null",
              "object"
            ],
            "additionalProperties": {
              "$ref": "#/components/schemas/BankConsentProperties"
            },
            "description": "Attributes that can be used when creating consents"
          },
          "logo": {
            "type": "string",
            "description": "Bank logo"
          },
          "onboarding": {
            "$ref": "#/components/schemas/BankOnboardingDetails"
          }
        },
        "additionalProperties": false
      },
      "BankingChannel": {
        "enum": [
          "unspecified",
          "openBanking",
          "psd2"
        ],
        "type": "string",
        "description": "The banking channel.",
        "example": "unspecified"
      },
      "BanksSearchResponse": {
        "type": "object",
        "properties": {
          "banks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BankItem"
            },
            "description": "A list of banks"
          }
        },
        "additionalProperties": false
      },
      "BasketTransactionStatus": {
        "enum": [
          "acsp",
          "actc",
          "acwc",
          "rcvd",
          "rjct"
        ],
        "type": "string",
        "example": "acsp",
        "x-enumDescriptions": {
          "acsp": "`AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.",
          "actc": "`AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.",
          "acwc": "`AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.",
          "rcvd": "`Received` - Payment initiation has been received by the receiving agent.",
          "rjct": "`Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected."
        }
      },
      "BookingStatus": {
        "enum": [
          "booked",
          "pending",
          "both",
          "information",
          "all"
        ],
        "type": "string",
        "example": "booked"
      },
      "Charge": {
        "type": "object",
        "properties": {
          "amount": {
            "$ref": "#/components/schemas/Money"
          },
          "chargeBearer": {
            "$ref": "#/components/schemas/ChargeBearerType"
          }
        },
        "additionalProperties": false,
        "description": "Provides details of the individual charge record."
      },
      "ChargeBearerType": {
        "enum": [
          "debt",
          "cred",
          "shar",
          "slev"
        ],
        "type": "string",
        "description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction.",
        "example": "debt",
        "x-enumDescriptions": {
          "debt": "All transaction charges are to be borne by the debtor.",
          "cred": "All transaction charges are to be borne by the creditor.",
          "shar": "In a credit transfer context, transaction charges on the sender side are borne by the debtor,\r\n            and transaction charges on the receiver side are borne by the creditor.\r\n            In a direct debit context, transaction charges on the sender side are borne by the creditor,\r\n            and transaction charges on the receiver side are borne by the debtor.",
          "slev": "Charges are applied following the rules agreed in the service level and/or scheme."
        }
      },
      "ClearingSystemDto": {
        "required": [
          "memberId"
        ],
        "type": "object",
        "properties": {
          "memberId": {
            "maxLength": 35,
            "minLength": 1,
            "type": "string",
            "description": "Clearing system member id",
            "example": "USABA123456789"
          }
        },
        "additionalProperties": false,
        "description": "Information about a clearing system member, which might be required for payments to non EEA member states."
      },
      "ConsentAdditionalData": {
        "type": "object",
        "properties": {
          "bankId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Id of the bank the consent applies to"
          },
          "expiresAtUtc": {
            "type": "string",
            "description": "Date the consent expires",
            "format": "date-time"
          },
          "consentData": {
            "type": [
              "null",
              "object"
            ],
            "additionalProperties": {
              "type": "string"
            },
            "description": "The consent-data, not generally available."
          }
        },
        "additionalProperties": false,
        "description": "Information about the consent that has been obtained"
      },
      "ConsentStatus": {
        "enum": [
          "unknown",
          "created",
          "started",
          "authorized",
          "expired",
          "revoked",
          "failure",
          "awaitingApproval"
        ],
        "type": "string",
        "description": "Status of the consent",
        "example": "unknown",
        "x-enumDescriptions": {
          "unknown": "",
          "created": "Consent session has been created",
          "started": "Consent flow has started",
          "authorized": "Consent has been obtained and is ready to be used",
          "expired": "The consent has expired",
          "revoked": "The consent has been revoked",
          "failure": "Failed to retrieve consent",
          "awaitingApproval": "Consent is being processed"
        }
      },
      "CreateAuthorizationResponse": {
        "type": "object",
        "properties": {
          "scaStatus": {
            "type": "string",
            "description": "Status of the SCA.\r\n\r\n**Example:**\r\n* `received`\r\n* `psuIdentified`\r\n* `psuAuthenticated`\r\n* `scaMethodSelected`\r\n* `unconfirmed`\r\n* `started`\r\n* `finalised`\r\n* `failed`\r\n* `exempted`",
            "example": "started"
          },
          "authorizationId": {
            "type": "string",
            "description": "Resource identification of the related SCA.",
            "example": "auth9000"
          },
          "_links": {
            "$ref": "#/components/schemas/PaymentAuthorizationLinks"
          }
        },
        "additionalProperties": false
      },
      "CreateConsentRequest": {
        "type": "object",
        "properties": {
          "bankId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional unique identifier of the bank you are creating consent for, if not specified the user will be asked to select one.\r\nThe unique identifiers can be found through the list bank API call (GET /banks).",
            "example": "89F7F63B-67C0-4F70-A6BE-898BC211DCA0"
          },
          "channelType": {
            "$ref": "#/components/schemas/BankingChannel"
          },
          "expires": {
            "type": [
              "null",
              "string"
            ],
            "description": "The time the consent should expire.\r\nDefaults to:\r\n  * psd2: 90 days\r\n  * openbanking: no expiration",
            "format": "date-time"
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Additional properties used for creating consents."
          },
          "redirectSettings": {
            "$ref": "#/components/schemas/RedirectSettings"
          },
          "state": {
            "type": [
              "null",
              "string"
            ],
            "description": "Can be used by client to keep track of consent flow.\r\nWill be returned in response to CreateConsent API call and \r\nadded to return url as a queryparameter if return url is specified.",
            "example": "qwerty"
          },
          "subscriptionId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Id of the subscription which this consent will created under.",
            "example": "992606c793984bcf81e543d90ecfbb36"
          },
          "resourceGroupName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Name of the resource-group which this consent will be organized under.",
            "example": "999999999"
          },
          "resourceGroupDisplayName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Display name of the resource-group which this consent will be organized under.",
            "example": "Organisation AB"
          }
        },
        "additionalProperties": false
      },
      "CreateConsentResponse": {
        "type": "object",
        "properties": {
          "consentId": {
            "type": "string",
            "description": "The consent id",
            "example": "1E5EFC3B-635E-4973-A605-41D7F0D6D7B3"
          },
          "resourceId": {
            "type": "string",
            "description": "Fully qualified resource id of the consent",
            "example": "/subscriptions/992606c793984bcf81e543d90ecfbb36/resource-groups/999999999/providers/aritma.banking/consents/0cb6e03a-c1d6-4d32-b438-0c2ad1e4079b"
          },
          "redirectUrl": {
            "type": [
              "null",
              "string"
            ],
            "description": "Url to redirect the user to.\r\nLanguage can be preselected with query parameter (ui-culture) when redirecting users.\r\nCurrent supported languages are nb (norwegian bokmål) and en (english, default).\r\nEx: https://google.com?ui-culture=nb",
            "example": "https://google.com"
          },
          "status": {
            "$ref": "#/components/schemas/ConsentStatus"
          },
          "state": {
            "type": [
              "null",
              "string"
            ],
            "description": "State from the request",
            "example": "qwerty"
          }
        },
        "additionalProperties": false
      },
      "CreditorReferenceInformation": {
        "required": [
          "reference"
        ],
        "type": "object",
        "properties": {
          "reference": {
            "maxLength": 35,
            "type": "string",
            "description": "The actual reference",
            "example": "Text, maximum of 35 characters."
          },
          "referenceTypeCode": {
            "$ref": "#/components/schemas/CreditorReferenceTypeCode"
          },
          "referenceTypeProprietary": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Type of the reference, provided in proprietary encoding",
            "example": "Text, maximum of 35 characters."
          },
          "referenceIssuer": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Issuer of the reference",
            "example": "Text, maximum of 35 characters."
          }
        },
        "additionalProperties": false,
        "description": "Reference information provided by the creditor to allow the identification of the underlying documents"
      },
      "CreditorReferenceTypeCode": {
        "enum": [
          "radm",
          "rpin",
          "fxdr",
          "disp",
          "puor",
          "scor"
        ],
        "type": "string",
        "description": "Type of the reference, provided as code",
        "example": "radm"
      },
      "EntryDetail": {
        "type": "object",
        "properties": {
          "references": {
            "$ref": "#/components/schemas/TransactionReferences"
          },
          "creditorId": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Identification of Creditors, e.g. a SEPA Creditor ID. example: Creditor Id 5678"
          },
          "transactionAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "amountDetails": {
            "$ref": "#/components/schemas/AmountDetails"
          },
          "charges": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Charge"
            },
            "description": "Provides information on the charges."
          },
          "currencyExchange": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportExchangeRate"
            },
            "description": "Currency exchange information."
          },
          "creditor": {
            "$ref": "#/components/schemas/TransactionParty"
          },
          "creditorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "debtor": {
            "$ref": "#/components/schemas/TransactionParty"
          },
          "debtorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "additionalTransactionInformation": {
            "type": [
              "null",
              "string"
            ]
          },
          "remittanceInformationUnstructured": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Array of unstructured remittance info, example: [\"Ref Number Merchant\", \"Some Other Text\"]"
          },
          "remittanceInformationStructured": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RemittanceInformationStructured"
            },
            "description": "Structured Remittance information"
          }
        },
        "additionalProperties": false,
        "description": "Details about a transaction within a batch."
      },
      "GenericAccountDto": {
        "required": [
          "identification",
          "schemeName"
        ],
        "type": "object",
        "properties": {
          "identification": {
            "minLength": 1,
            "type": "string",
            "description": "Account identification.",
            "example": "123-1234"
          },
          "schemeName": {
            "minLength": 1,
            "type": "string",
            "description": "Name of the identification scheme.\r\n**Example:**\r\n* `BBAN`: Basic Bank Account Number.\r\n* `BGNR`: Bankgirot number.\r\n* `PGNR`: PlusGirot number.\r\n* `giro`: Giro Denmark.",
            "example": "BGNR"
          }
        },
        "additionalProperties": false,
        "description": "Generic account reference."
      },
      "GetBulkPaymentResponse": {
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "Resource identifier of the payment initiation.",
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          "transactionStatus": {
            "$ref": "#/components/schemas/TransactionStatus"
          },
          "tppMessage": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TppMessage"
            },
            "description": "Messages from the ASPSP to the TPP on operational issues."
          },
          "requestedExecutionDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "The requested execution date of the payment.",
            "format": "date"
          },
          "debtorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "debtorName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Debtor name.",
            "example": "Max Mustermann"
          },
          "debtorAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "Timestamp when the payment was created.",
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "Timestamp when the payment was last updated.",
            "format": "date-time"
          },
          "_links": {
            "$ref": "#/components/schemas/PagedPaymentInitiationLinks"
          },
          "batchBookingPreferred": {
            "type": "boolean",
            "description": "If set to true, the payment service provider should attempt to book all transactions in a single batch."
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentLineResponseDto"
            },
            "description": "The individual payment lines within the bulk payment."
          }
        },
        "additionalProperties": false
      },
      "GetBulkPaymentsResponse": {
        "type": "object",
        "properties": {
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentLinksBulkPaymentResponse"
            }
          },
          "_links": {
            "$ref": "#/components/schemas/Links"
          }
        },
        "additionalProperties": false
      },
      "GetConsentResponse": {
        "type": "object",
        "properties": {
          "consentId": {
            "type": "string",
            "description": "The consent id",
            "example": "1E5EFC3B-635E-4973-A605-41D7F0D6D7B3"
          },
          "resourceId": {
            "type": "string",
            "description": "Fully qualified resource id of the consent",
            "example": "/subscriptions/992606c793984bcf81e543d90ecfbb36/resource-groups/999999999/providers/aritma.banking/consents/0cb6e03a-c1d6-4d32-b438-0c2ad1e4079b"
          },
          "status": {
            "$ref": "#/components/schemas/ConsentStatus"
          },
          "additionalData": {
            "$ref": "#/components/schemas/ConsentAdditionalData"
          }
        },
        "additionalProperties": false
      },
      "GetConsentsResponse": {
        "type": "object",
        "properties": {
          "consents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GetConsentResponse"
            },
            "description": "The consents"
          },
          "_links": {
            "$ref": "#/components/schemas/Links"
          }
        },
        "additionalProperties": false
      },
      "GetPaymentResponse": {
        "required": [
          "creditorAccount",
          "creditorName",
          "instructedAmount"
        ],
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "Resource identifier of the payment initiation.",
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          "transactionStatus": {
            "$ref": "#/components/schemas/TransactionStatus"
          },
          "tppMessage": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TppMessage"
            },
            "description": "Messages from the ASPSP to the TPP on operational issues."
          },
          "requestedExecutionDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "The requested execution date of the payment.",
            "format": "date"
          },
          "debtorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "debtorName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Debtor name.",
            "example": "Max Mustermann"
          },
          "debtorAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "Timestamp when the payment was created.",
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "Timestamp when the payment was last updated.",
            "format": "date-time"
          },
          "_links": {
            "$ref": "#/components/schemas/PaymentInitiationLinks"
          },
          "endToEndIdentification": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "End to end identification"
          },
          "instructedAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "creditorAccount": {
            "$ref": "#/components/schemas/AccountNumbers"
          },
          "creditorAgent": {
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}",
            "type": [
              "null",
              "string"
            ],
            "description": "BICFI",
            "example": "DNBANOKK"
          },
          "creditorAgentCountryCode": {
            "pattern": "[A-Z]{2}",
            "type": [
              "null",
              "string"
            ],
            "description": "Country code of the creditor agent.",
            "example": "NO"
          },
          "creditorAgentClearingSystem": {
            "$ref": "#/components/schemas/ClearingSystemDto"
          },
          "creditorName": {
            "maxLength": 70,
            "minLength": 1,
            "type": "string",
            "description": "Creditor name",
            "example": "Ola"
          },
          "creditorAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "remittanceInformationUnstructured": {
            "maxLength": 140,
            "type": [
              "null",
              "string"
            ],
            "description": "Unstructured remittance information",
            "example": "message"
          },
          "remittanceInformationStructured": {
            "$ref": "#/components/schemas/RemittanceInformation"
          },
          "remittanceInformationStructuredArray": {
            "type": [
              "null",
              "array"
            ],
            "items": {
              "$ref": "#/components/schemas/RemittanceInformation"
            }
          },
          "purposeCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "ISO 20022 ExternalPurpose1Code"
          },
          "purposeProprietary": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Purpose in a proprietary form."
          },
          "regulatoryReportingAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "regulatoryReportingCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "Regulatory reporting code",
            "example": "26"
          },
          "regulatoryReportingInformation": {
            "type": [
              "null",
              "string"
            ],
            "description": "Regulatory reporting info",
            "example": "Rent"
          },
          "bundleReference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Reference that can be used for choosing what payments will be bundled together",
            "example": "bundle-id-123456789"
          },
          "instructionPriority": {
            "$ref": "#/components/schemas/InstructionPriorityCode"
          }
        },
        "additionalProperties": false
      },
      "HttpVerb": {
        "enum": [
          "get",
          "post",
          "put",
          "delete"
        ],
        "type": "string",
        "example": "get"
      },
      "InitiateBulkPaymentResponse": {
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "Resource identifier of the bulk payment initiation.",
            "example": "p1b52718ebabcd14affa29261a32d864557"
          },
          "transactionStatus": {
            "$ref": "#/components/schemas/TransactionStatus"
          },
          "_links": {
            "$ref": "#/components/schemas/PaymentInitiationLinks"
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentReference"
            },
            "description": "A list of payment references."
          }
        },
        "additionalProperties": false,
        "description": "Response to a bulk payment initiation request."
      },
      "InitiatePaymentResponse": {
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "Resource identifier of the payment initiation.",
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          "transactionStatus": {
            "$ref": "#/components/schemas/TransactionStatus"
          },
          "tppMessage": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TppMessage"
            },
            "description": "Messages from the ASPSP to the TPP on operational issues."
          },
          "_links": {
            "$ref": "#/components/schemas/PaymentInitiationLinks"
          }
        },
        "additionalProperties": false
      },
      "InstructionPriorityCode": {
        "enum": [
          "normal",
          "high",
          "urgent"
        ],
        "type": "string",
        "description": "Indictator of the urgency or order of importance that the payment is requested processed.",
        "example": "normal",
        "x-enumDescriptions": {
          "normal": "Standard payment with normal priority (D+1).",
          "high": "Standard payment with high priority (D+0).",
          "urgent": "Urgent payment (instant payment)."
        }
      },
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "Url to a resource",
            "example": "https://banking.aritma.io/api/resource?cursor=abc123"
          },
          "verb": {
            "$ref": "#/components/schemas/HttpVerb"
          }
        },
        "additionalProperties": false
      },
      "Links": {
        "type": "object",
        "properties": {
          "next": {
            "$ref": "#/components/schemas/Link"
          },
          "previous": {
            "$ref": "#/components/schemas/Link"
          }
        },
        "additionalProperties": false,
        "description": "Pagination links for navigating between pages of results."
      },
      "Money": {
        "type": "object",
        "properties": {
          "currency": {
            "type": [
              "null",
              "string"
            ],
            "description": "The three-letter currency code of the amount - ISO 4217",
            "example": "NOK"
          },
          "amount": {
            "pattern": "-?[0-9]{1,14}(\\.[0-9]{1,3})?",
            "type": [
              "null",
              "string"
            ],
            "description": "The amount value. Negative amounts are signed by minus. The decimal separator is a dot.\r\n            \r\n**Example:**\r\n* 0\r\n* 154\r\n* -1.75\r\n* 349.7\r\n* 3632.78",
            "example": "3632.78"
          }
        },
        "additionalProperties": false,
        "description": "Amount with currency"
      },
      "PagedPaymentInitiationLinks": {
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/Link"
          },
          "status": {
            "$ref": "#/components/schemas/Link"
          },
          "startAuthorization": {
            "$ref": "#/components/schemas/Link"
          },
          "scaRedirect": {
            "$ref": "#/components/schemas/Link"
          },
          "next": {
            "$ref": "#/components/schemas/Link"
          },
          "prev": {
            "$ref": "#/components/schemas/Link"
          }
        },
        "additionalProperties": false,
        "description": "Links related to a paged payment initiation response."
      },
      "PaymentAuthorizationLinks": {
        "type": "object",
        "properties": {
          "scaRedirect": {
            "$ref": "#/components/schemas/Link"
          },
          "scaOauth": {
            "$ref": "#/components/schemas/Link"
          },
          "confirmation": {
            "$ref": "#/components/schemas/Link"
          },
          "self": {
            "$ref": "#/components/schemas/Link"
          }
        },
        "additionalProperties": false
      },
      "PaymentDeleteResponse": {
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "Resource identifier of the cancelled payment initiation.",
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          "transactionStatus": {
            "$ref": "#/components/schemas/TransactionStatus"
          }
        },
        "additionalProperties": false,
        "description": "Response to a payment cancellation request."
      },
      "PaymentInitiationLinks": {
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/Link"
          },
          "status": {
            "$ref": "#/components/schemas/Link"
          },
          "startAuthorization": {
            "$ref": "#/components/schemas/Link"
          },
          "scaRedirect": {
            "$ref": "#/components/schemas/Link"
          }
        },
        "additionalProperties": false,
        "description": "Links related to a payment initiation, including authorisation links."
      },
      "PaymentLine": {
        "required": [
          "creditorAccount",
          "creditorName",
          "instructedAmount"
        ],
        "type": "object",
        "properties": {
          "endToEndIdentification": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "End to end identification"
          },
          "instructedAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "creditorAccount": {
            "$ref": "#/components/schemas/AccountNumbers"
          },
          "creditorAgent": {
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}",
            "type": [
              "null",
              "string"
            ],
            "description": "BICFI",
            "example": "DNBANOKK"
          },
          "creditorAgentCountryCode": {
            "pattern": "[A-Z]{2}",
            "type": [
              "null",
              "string"
            ],
            "description": "Country code of the creditor agent.",
            "example": "NO"
          },
          "creditorAgentClearingSystem": {
            "$ref": "#/components/schemas/ClearingSystemDto"
          },
          "creditorName": {
            "maxLength": 70,
            "minLength": 1,
            "type": "string",
            "description": "Creditor name",
            "example": "Ola"
          },
          "creditorAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "remittanceInformationUnstructured": {
            "maxLength": 140,
            "type": [
              "null",
              "string"
            ],
            "description": "Unstructured remittance information",
            "example": "message"
          },
          "remittanceInformationStructured": {
            "$ref": "#/components/schemas/RemittanceInformation"
          },
          "remittanceInformationStructuredArray": {
            "type": [
              "null",
              "array"
            ],
            "items": {
              "$ref": "#/components/schemas/RemittanceInformation"
            }
          },
          "purposeCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "External purpose code (ExternalPurpose1Code from ISO 20022)\r\n            \r\n**Example:**\r\n* SUPP: Payment to a supplier.\r\n* SALA: Payment of salaries.\r\n* IPAY: Instant payment.\r\n* INTC: Intra-company payment.\r\n* TAXS: Payment of taxes.\r\n* PENS: Payment of pension.\r\n* TREA: Treasury operations.\r\n* CORT: Settlement of a trade, e.g. a foreign exchange deal or a securities transaction.\r\n\r\nAn example usage of this field is for salary payments. They would typically use the purpose code \"SALA\"."
          },
          "purposeProprietary": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Purpose in a proprietary form."
          },
          "categoryPurposeCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "External category purpose code (ExternalCategoryPurpose1Code from ISO 20022)\r\n\r\nSupported values are: [\r\nBONU, CASH, CBLK, CCRD, CORT, DCRD, DIVI, DVPM, EPAY, FCIN, FCOL,\r\nGP2P, GOVT, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P,\r\nOTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, TAXS, TRAD,\r\nTREA, VATX, WHLD, SWEP, TOPG, ZABA, VOST, FCDT, CIPC, CONC, CGWV,\r\nSAVG, CTDF\r\n]\r\nAn example usage of this field is for salary payments. They would typically use the purpose code \"SALA\"."
          },
          "regulatoryReportingAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "regulatoryReportingCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "Regulatory reporting code",
            "example": "26"
          },
          "regulatoryReportingInformation": {
            "type": [
              "null",
              "string"
            ],
            "description": "Regulatory reporting info",
            "example": "Rent"
          },
          "bundleReference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Reference that can be used for choosing what payments will be bundled together",
            "example": "bundle-id-123456789"
          },
          "instructionPriority": {
            "$ref": "#/components/schemas/InstructionPriorityCode"
          }
        },
        "additionalProperties": false
      },
      "PaymentLineResponseDto": {
        "required": [
          "creditorAccount",
          "creditorName",
          "instructedAmount"
        ],
        "type": "object",
        "properties": {
          "endToEndIdentification": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "End to end identification"
          },
          "instructedAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "creditorAccount": {
            "$ref": "#/components/schemas/AccountNumbers"
          },
          "creditorAgent": {
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}",
            "type": [
              "null",
              "string"
            ],
            "description": "BICFI",
            "example": "DNBANOKK"
          },
          "creditorAgentCountryCode": {
            "pattern": "[A-Z]{2}",
            "type": [
              "null",
              "string"
            ],
            "description": "Country code of the creditor agent.",
            "example": "NO"
          },
          "creditorAgentClearingSystem": {
            "$ref": "#/components/schemas/ClearingSystemDto"
          },
          "creditorName": {
            "maxLength": 70,
            "minLength": 1,
            "type": "string",
            "description": "Creditor name",
            "example": "Ola"
          },
          "creditorAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "remittanceInformationUnstructured": {
            "maxLength": 140,
            "type": [
              "null",
              "string"
            ],
            "description": "Unstructured remittance information",
            "example": "message"
          },
          "remittanceInformationStructured": {
            "$ref": "#/components/schemas/RemittanceInformation"
          },
          "remittanceInformationStructuredArray": {
            "type": [
              "null",
              "array"
            ],
            "items": {
              "$ref": "#/components/schemas/RemittanceInformation"
            }
          },
          "purposeCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "External purpose code (ExternalPurpose1Code from ISO 20022)\r\n            \r\n**Example:**\r\n* SUPP: Payment to a supplier.\r\n* SALA: Payment of salaries.\r\n* IPAY: Instant payment.\r\n* INTC: Intra-company payment.\r\n* TAXS: Payment of taxes.\r\n* PENS: Payment of pension.\r\n* TREA: Treasury operations.\r\n* CORT: Settlement of a trade, e.g. a foreign exchange deal or a securities transaction.\r\n\r\nAn example usage of this field is for salary payments. They would typically use the purpose code \"SALA\"."
          },
          "purposeProprietary": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Purpose in a proprietary form."
          },
          "categoryPurposeCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "External category purpose code (ExternalCategoryPurpose1Code from ISO 20022)\r\n\r\nSupported values are: [\r\nBONU, CASH, CBLK, CCRD, CORT, DCRD, DIVI, DVPM, EPAY, FCIN, FCOL,\r\nGP2P, GOVT, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P,\r\nOTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, TAXS, TRAD,\r\nTREA, VATX, WHLD, SWEP, TOPG, ZABA, VOST, FCDT, CIPC, CONC, CGWV,\r\nSAVG, CTDF\r\n]\r\nAn example usage of this field is for salary payments. They would typically use the purpose code \"SALA\"."
          },
          "regulatoryReportingAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "regulatoryReportingCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "Regulatory reporting code",
            "example": "26"
          },
          "regulatoryReportingInformation": {
            "type": [
              "null",
              "string"
            ],
            "description": "Regulatory reporting info",
            "example": "Rent"
          },
          "bundleReference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Reference that can be used for choosing what payments will be bundled together",
            "example": "bundle-id-123456789"
          },
          "instructionPriority": {
            "$ref": "#/components/schemas/InstructionPriorityCode"
          },
          "paymentId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Unique payment identification"
          },
          "transactionStatus": {
            "$ref": "#/components/schemas/TransactionStatus"
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "null",
              "string"
            ],
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "PaymentLinks": {
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/Link"
          },
          "status": {
            "$ref": "#/components/schemas/Link"
          }
        },
        "additionalProperties": false,
        "description": "Links related to a payment resource."
      },
      "PaymentLinksBulkPaymentResponse": {
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "Resource identifier of the payment initiation.",
            "example": "p1pbb64b18233714bf38204314e3faa03bc"
          },
          "transactionStatus": {
            "$ref": "#/components/schemas/TransactionStatus"
          },
          "tppMessage": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TppMessage"
            },
            "description": "Messages from the ASPSP to the TPP on operational issues."
          },
          "requestedExecutionDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "The requested execution date of the payment.",
            "format": "date"
          },
          "debtorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "debtorName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Debtor name.",
            "example": "Max Mustermann"
          },
          "debtorAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "Timestamp when the payment was created.",
            "format": "date-time"
          },
          "updatedAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "Timestamp when the payment was last updated.",
            "format": "date-time"
          },
          "_links": {
            "$ref": "#/components/schemas/PaymentLinks"
          }
        },
        "additionalProperties": false
      },
      "PaymentParameters": {
        "type": "object",
        "properties": {
          "requiredAuthorizations": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The total number of authorizations required for payments.",
            "format": "int32",
            "example": 1
          },
          "accountingApprovedPayments": {
            "type": [
              "null",
              "boolean"
            ],
            "description": "If accounting approved payments (RGB) are enabled for payments",
            "example": true
          }
        },
        "additionalProperties": false,
        "description": "Parameters for payments."
      },
      "PaymentProduct": {
        "enum": [
          "credit-transfer",
          "direct-debit"
        ],
        "type": "string",
        "example": "credit-transfer",
        "x-enumDescriptions": {
          "credit-transfer": "Represents a payment made using the credit transfer method.\r\n            \r\n\r\n            credit-transfer",
          "direct-debit": "Represents a payment method where funds are withdrawn directly from a bank account using direct debit.\r\n            \r\n\r\n            direct-debit"
        }
      },
      "PaymentReference": {
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "Id of the payment",
            "example": "p1b6523d427c32efc47ee1f9530"
          },
          "endToEndIdentification": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "End to end identification"
          }
        },
        "additionalProperties": false
      },
      "PaymentRequestBulk": {
        "required": [
          "debtorAccount"
        ],
        "type": "object",
        "properties": {
          "debtorAccount": {
            "$ref": "#/components/schemas/AccountNumbers"
          },
          "debtorName": {
            "type": [
              "null",
              "string"
            ],
            "description": "Debtor name.",
            "example": "Max Mustermann"
          },
          "debtorAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "batchBookingPreferred": {
            "type": "boolean",
            "description": "If set to true, the payment service provider should attempt to book all transactions in a single batch."
          },
          "requestedExecutionDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "The requested execution date of the payment.",
            "format": "date"
          },
          "paymentLines": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentLine"
            },
            "description": "The individual payment lines within the bulk payment."
          }
        },
        "additionalProperties": false,
        "description": "Bulk payment initiation request containing multiple payment lines sharing the same debtor account."
      },
      "PaymentService": {
        "enum": [
          "payments",
          "bulk-payments"
        ],
        "type": "string",
        "example": "payments",
        "x-enumDescriptions": {
          "payments": "Represents the payments resource type.\r\n            \r\n\r\n            payments",
          "bulk-payments": "Represents the bulk payments operation type.\r\n            \r\n\r\n            bulk-payments"
        }
      },
      "PostalAddress": {
        "type": "object",
        "properties": {
          "addressLines": {
            "maxItems": 7,
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "At most seven entries are permitted. May only be used, \r\nif none of the structured address elements \"streetName\", \"buildingNumber\", \"postcode\" or \"townName\" is used."
          },
          "streetName": {
            "maxLength": 70,
            "type": [
              "null",
              "string"
            ],
            "description": "Name of a street or thoroughfare.",
            "example": "River Street"
          },
          "buildingNumber": {
            "maxLength": 16,
            "type": [
              "null",
              "string"
            ],
            "description": "Number that identifies the position of a building on a street.",
            "example": "12"
          },
          "postCode": {
            "maxLength": 16,
            "type": [
              "null",
              "string"
            ],
            "description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.",
            "example": "12345"
          },
          "townName": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Name of a built-up area, with defined boundaries, and a local government. Usage Rule: If address lines are not used, this attribute is mandatory.",
            "example": "Oslo"
          },
          "country": {
            "maxLength": 70,
            "pattern": "[A-Z]{2}",
            "type": [
              "null",
              "string"
            ],
            "description": "Nation with its own government.Usage Rule: If address lines are not used, this attribute is mandatory.",
            "example": "NO"
          }
        },
        "additionalProperties": false
      },
      "PostalAddressDto": {
        "type": "object",
        "properties": {
          "country": {
            "pattern": "[A-Z]{2}",
            "type": [
              "null",
              "string"
            ],
            "description": "Country of the postal address.",
            "example": "NO"
          }
        },
        "additionalProperties": false,
        "description": "Postal address of a party."
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": [
              "null",
              "string"
            ]
          },
          "title": {
            "type": [
              "null",
              "string"
            ]
          },
          "status": {
            "type": [
              "null",
              "integer"
            ],
            "format": "int32"
          },
          "detail": {
            "type": [
              "null",
              "string"
            ]
          },
          "instance": {
            "type": [
              "null",
              "string"
            ]
          }
        },
        "additionalProperties": {}
      },
      "PropType": {
        "enum": [
          "string",
          "number",
          "integer",
          "boolean",
          "array"
        ],
        "type": "string",
        "description": "The type of the field",
        "example": "string"
      },
      "PropertyCondition": {
        "type": "object",
        "properties": {
          "property": {
            "type": "string",
            "description": "A property key"
          },
          "predicate": {
            "$ref": "#/components/schemas/PropertyConditionPredicate"
          },
          "value": {
            "type": "string",
            "description": "A property value"
          }
        },
        "additionalProperties": false,
        "description": "An optional property condition that must be met in order for this property to apply"
      },
      "PropertyConditionPredicate": {
        "enum": [
          "eq",
          "lt",
          "gt"
        ],
        "type": "string",
        "example": "eq"
      },
      "RedirectSettings": {
        "type": "object",
        "properties": {
          "success": {
            "type": [
              "null",
              "string"
            ],
            "description": "The url to redirect the user to after a successful consent creation flow.\r\nIf not specified the user is redirected to a default landing page after successfully completing the flow.",
            "example": "https://www.google.com/search?q=success"
          },
          "error": {
            "type": [
              "null",
              "string"
            ],
            "description": "The url to redirect the user to if something goes wrong.\r\nIf not specified the user is redirected to a default error page if something went wrong.",
            "example": "https://www.google.com/search?q=error"
          }
        },
        "additionalProperties": false,
        "description": "Contains settings for redirects"
      },
      "ReferredDocumentInformation": {
        "type": "object",
        "properties": {
          "typeCode": {
            "$ref": "#/components/schemas/ReferredDocumentTypeCode"
          },
          "typeProprietary": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Specifies the type of referred document, provided in proprietary encoding",
            "example": "Text, maximum of 35 characters."
          },
          "typeIssuer": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Issuer of the document type",
            "example": "Text, maximum of 35 characters."
          },
          "number": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Unique and unambiguous identification of the referred document",
            "example": "Text, maximum of 35 characters."
          },
          "relatedDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "Date associated with the referred document",
            "format": "date-time",
            "example": "2020-01-01T13:00:00.999+00:00"
          }
        },
        "additionalProperties": false,
        "description": "Set of elements used to identify the documents referred to in the remittance information"
      },
      "ReferredDocumentTypeCode": {
        "enum": [
          "msin",
          "cnfa",
          "dnfa",
          "cinv",
          "cren",
          "debn",
          "hiri",
          "sbin",
          "cmcn",
          "soac",
          "disp",
          "bold",
          "vchr",
          "aroi",
          "tsut",
          "puor"
        ],
        "type": "string",
        "description": "Specifies the type of referred document, provided as code",
        "example": "msin"
      },
      "RefreshConsentRequest": {
        "type": "object",
        "properties": {
          "expires": {
            "type": [
              "null",
              "string"
            ],
            "description": "The time the consent should expire.\r\nDefaults to:\r\n  * psd2: 90 days\r\n  * openbanking: no expiration",
            "format": "date-time"
          },
          "redirectSettings": {
            "$ref": "#/components/schemas/RedirectSettings"
          },
          "state": {
            "type": [
              "null",
              "string"
            ],
            "description": "Can be used by client to keep track of consent flow.\r\nWill be returned in response to CreateConsent API call and \r\nadded to return url as a queryparameter if return url is specified.",
            "example": "qwerty"
          }
        },
        "additionalProperties": false
      },
      "RemittanceInformation": {
        "type": "object",
        "properties": {
          "reference": {
            "maxLength": 35,
            "minLength": 1,
            "type": [
              "null",
              "string"
            ],
            "description": "Reference",
            "example": "777588823"
          },
          "referenceType": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Reference type",
            "example": "SCOR"
          },
          "referenceIssuer": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ]
          }
        },
        "additionalProperties": false,
        "description": "Structured remittance information"
      },
      "RemittanceInformationStructured": {
        "type": "object",
        "properties": {
          "remittanceAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "referredDocumentInformation": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReferredDocumentInformation"
            },
            "description": "Set of elements used to identify the documents referred to in the remittance information"
          },
          "creditorReferenceInformation": {
            "$ref": "#/components/schemas/CreditorReferenceInformation"
          },
          "additionalRemittanceInformation": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Additional information to be displayed to the PSU e.g. within authorisation processes. This will not be used in related interbank payments"
          }
        },
        "additionalProperties": false,
        "description": "Structured remittance information"
      },
      "ReportExchangeRate": {
        "required": [
          "exchangeRate",
          "sourceCurrency"
        ],
        "type": "object",
        "properties": {
          "sourceCurrency": {
            "pattern": "[A-Z]{3}",
            "type": "string",
            "description": "Currency from which an amount is to be converted in a currency conversion",
            "example": "EUR"
          },
          "exchangeRate": {
            "type": "number",
            "description": "Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency",
            "format": "double"
          },
          "unitCurrency": {
            "pattern": "[A-Z]{3}",
            "type": [
              "null",
              "string"
            ],
            "description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR",
            "example": "EUR"
          },
          "targetCurrency": {
            "pattern": "[A-Z]{3}",
            "type": [
              "null",
              "string"
            ],
            "description": "Currency into which an amount is to be converted in a currency conversion",
            "example": "EUR"
          },
          "quotationDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "Date at which an exchange rate is quoted",
            "format": "date-time"
          },
          "contractId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Unique identification to unambiguously identify the foreign exchange contract"
          }
        },
        "additionalProperties": false
      },
      "ResourceMetadataDto": {
        "type": "object",
        "properties": {
          "subscriptionId": {
            "type": "string",
            "description": "Id of the subscription",
            "example": "foo"
          },
          "resourceGroupId": {
            "type": "string",
            "description": "Id of the resource-group",
            "example": "company-x"
          },
          "resourceId": {
            "type": "string",
            "description": "Fully qualified resource uri.",
            "example": "/subscriptions/foo/resource-groups/company-x/providers/aritma.openbanking/accounts/1234"
          }
        },
        "additionalProperties": false,
        "description": "Metadata about the resource."
      },
      "SelectPsuAuthenticationMethod": {
        "type": "object",
        "properties": {
          "authenticationMethodId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Identification used for later authentication method selection."
          },
          "authenticationMethodAcrValues": {
            "type": [
              "null",
              "string"
            ],
            "description": "Acr values used for later authentication method selection."
          }
        },
        "additionalProperties": false
      },
      "SigningBasket": {
        "required": [
          "paymentIds"
        ],
        "type": "object",
        "properties": {
          "paymentIds": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Resource identifiers of the payments to include in the signing basket.",
            "example": [
              "p1pbb64b18233714bf38204314e3faa03bc"
            ]
          }
        },
        "additionalProperties": false,
        "description": "Request to create a signing basket containing payment identifiers to be authorised together."
      },
      "SigningBasketResponse": {
        "type": "object",
        "properties": {
          "transactionStatus": {
            "$ref": "#/components/schemas/BasketTransactionStatus"
          },
          "basketId": {
            "type": "string",
            "description": "Resource identifier of the signing basket.",
            "example": "4f0d36c610d44e60af3c244259aa7779"
          },
          "paymentIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Resource identifiers of the payments included in the signing basket.",
            "example": [
              "p1pbb64b18233714bf38204314e3faa03bc"
            ]
          },
          "consentIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Resource identifiers of the consents included in the signing basket.",
            "example": [
              "1E5EFC3B-635E-4973-A605-41D7F0D6D7B3"
            ]
          },
          "_links": {
            "$ref": "#/components/schemas/PaymentInitiationLinks"
          }
        },
        "additionalProperties": false,
        "description": "Response containing a signing basket resource with its associated payments and status."
      },
      "SigningBasketStatusResponse": {
        "type": "object",
        "properties": {
          "transactionStatus": {
            "$ref": "#/components/schemas/BasketTransactionStatus"
          }
        },
        "additionalProperties": false,
        "description": "Transaction status of a signing basket."
      },
      "StatusType": {
        "enum": [
          "enabled",
          "deleted",
          "blocked"
        ],
        "type": "string",
        "example": "enabled"
      },
      "TppMessage": {
        "required": [
          "category",
          "code"
        ],
        "type": "object",
        "properties": {
          "category": {
            "$ref": "#/components/schemas/TppMessageCategory"
          },
          "code": {
            "minLength": 1,
            "type": "string",
            "description": "Code of the TPP message.",
            "example": "AC03"
          },
          "message": {
            "type": [
              "null",
              "string"
            ],
            "description": "Additional explaining text."
          }
        },
        "additionalProperties": false
      },
      "TppMessageCategory": {
        "enum": [
          "ERROR",
          "WARNING"
        ],
        "type": "string",
        "example": "ERROR"
      },
      "Transaction": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "description": "Id of the transaction",
            "example": "DEAF96E4-5063-46D9-89D4-E32A8E51994C"
          },
          "accountId": {
            "type": "string",
            "description": "Account id used to retrieve the transaction",
            "example": "1234"
          },
          "entryReference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Entry reference of the transaction",
            "example": "123456789"
          },
          "references": {
            "$ref": "#/components/schemas/TransactionReferences"
          },
          "valueDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "Date at which the assets become available or cease to be available,\r\ncould be an expected date if state is `pending`.",
            "format": "date-time",
            "example": "2025-10-25T22:20:31.8361914+00:00"
          },
          "bookingDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "Booking date of the transaction",
            "format": "date-time",
            "example": "2025-10-26T07:20:31.8361914+00:00"
          },
          "transactionAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "amountDetails": {
            "$ref": "#/components/schemas/AmountDetails"
          },
          "currencyExchange": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportExchangeRate"
            },
            "description": "Currency exchange information."
          },
          "charge": {
            "$ref": "#/components/schemas/Charge"
          },
          "creditor": {
            "$ref": "#/components/schemas/TransactionParty"
          },
          "creditorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "debtor": {
            "$ref": "#/components/schemas/TransactionParty"
          },
          "debtorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "remittanceInformationUnstructured": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Array of unstructured remittance info, example: [\"Ref Number Merchant\", \"Some Other Text\"]"
          },
          "remittanceInformationStructured": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RemittanceInformationStructured"
            },
            "description": "Structured Remittance information"
          },
          "purposeCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "External purpose code (ExternalPurpose1Code from ISO 20022)",
            "example": "SALA"
          },
          "purposeProprietary": {
            "type": [
              "null",
              "string"
            ],
            "description": "Proprietary purpose"
          },
          "bankTransactionCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "Bank transaction code as used by the ASPSP (ISO 20022)"
          },
          "bankTransactionCodeProprietary": {
            "type": [
              "null",
              "string"
            ],
            "description": "Proprietary bank transaction code as used by the ASPSP"
          },
          "additionalInformation": {
            "type": [
              "null",
              "string"
            ],
            "description": "Additional transaction related information from the ASPSP to the PSU"
          },
          "entryDetailsCount": {
            "type": [
              "null",
              "integer"
            ],
            "description": "A count of how many entry details that exist.",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "A single transaction"
      },
      "TransactionDetail": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "description": "Id of the transaction",
            "example": "DEAF96E4-5063-46D9-89D4-E32A8E51994C"
          },
          "accountId": {
            "type": "string",
            "description": "Account id used to retrieve the transaction",
            "example": "1234"
          },
          "entryReference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Entry reference of the transaction",
            "example": "123456789"
          },
          "references": {
            "$ref": "#/components/schemas/TransactionReferences"
          },
          "valueDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "Date at which the assets become available or cease to be available,\r\ncould be an expected date if state is `pending`.",
            "format": "date-time",
            "example": "2025-10-25T22:20:31.8361914+00:00"
          },
          "bookingDate": {
            "type": [
              "null",
              "string"
            ],
            "description": "Booking date of the transaction",
            "format": "date-time",
            "example": "2025-10-26T07:20:31.8361914+00:00"
          },
          "transactionAmount": {
            "$ref": "#/components/schemas/Money"
          },
          "amountDetails": {
            "$ref": "#/components/schemas/AmountDetails"
          },
          "currencyExchange": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportExchangeRate"
            },
            "description": "Currency exchange information."
          },
          "charge": {
            "$ref": "#/components/schemas/Charge"
          },
          "creditor": {
            "$ref": "#/components/schemas/TransactionParty"
          },
          "creditorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "debtor": {
            "$ref": "#/components/schemas/TransactionParty"
          },
          "debtorAccount": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "remittanceInformationUnstructured": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Array of unstructured remittance info, example: [\"Ref Number Merchant\", \"Some Other Text\"]"
          },
          "remittanceInformationStructured": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RemittanceInformationStructured"
            },
            "description": "Structured Remittance information"
          },
          "purposeCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "External purpose code (ExternalPurpose1Code from ISO 20022)",
            "example": "SALA"
          },
          "purposeProprietary": {
            "type": [
              "null",
              "string"
            ],
            "description": "Proprietary purpose"
          },
          "bankTransactionCode": {
            "type": [
              "null",
              "string"
            ],
            "description": "Bank transaction code as used by the ASPSP (ISO 20022)"
          },
          "bankTransactionCodeProprietary": {
            "type": [
              "null",
              "string"
            ],
            "description": "Proprietary bank transaction code as used by the ASPSP"
          },
          "additionalInformation": {
            "type": [
              "null",
              "string"
            ],
            "description": "Additional transaction related information from the ASPSP to the PSU"
          },
          "entryDetailsCount": {
            "type": [
              "null",
              "integer"
            ],
            "description": "A count of how many entry details that exist.",
            "format": "int32"
          },
          "entryDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EntryDetail"
            },
            "description": "Details about transactions within a batch."
          },
          "_links": {
            "$ref": "#/components/schemas/Links"
          }
        },
        "additionalProperties": false,
        "description": "A single transaction detail"
      },
      "TransactionDetailsResponse": {
        "type": "object",
        "properties": {
          "transactionDetails": {
            "$ref": "#/components/schemas/TransactionDetail"
          }
        },
        "additionalProperties": false,
        "description": "Response containing details for a single transaction."
      },
      "TransactionParty": {
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 140,
            "type": [
              "null",
              "string"
            ],
            "description": "Name of the party.",
            "example": "Credit AS"
          },
          "postalAddress": {
            "$ref": "#/components/schemas/PostalAddress"
          }
        },
        "additionalProperties": false
      },
      "TransactionReferences": {
        "type": "object",
        "properties": {
          "endToEndIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "EndToEnd ids for the transaction"
          },
          "instructionId": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Instruction Identification from pain.001 in outgoing payments",
            "example": "123456789"
          },
          "accountServicerReference": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the instruction.\r\nAlso known as \"Archive Reference\".",
            "example": "123456789"
          },
          "mandateId": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Direct debit related mandate.",
            "example": "123456789"
          },
          "checkNumber": {
            "maxLength": 35,
            "type": [
              "null",
              "string"
            ],
            "description": "Unique and unambiguous identifier for a cheque as assigned by the agent.",
            "example": "123456789"
          }
        },
        "additionalProperties": false,
        "description": "References to the transaction."
      },
      "TransactionSource": {
        "enum": [
          "default",
          "creditDebitNotification",
          "statement"
        ],
        "type": "string",
        "example": "default",
        "x-enumDescriptions": {
          "default": "Will give transactions only from Camt.53. Specifying this value is the same as omitting the field or choosing statement",
          "creditDebitNotification": "Notifications are files usually delivered from the bank multiple times a day,\r\n            and contains comprehensive information on transactions (Filetype : Camt.54)",
          "statement": "Statements are files usually delivered from the bank one time a day,\r\n            at the end of the day contains information on transactions (Filetype : Camt.53)"
        }
      },
      "TransactionStatus": {
        "enum": [
          "accc",
          "accp",
          "acsc",
          "acsp",
          "actc",
          "acwc",
          "acwp",
          "rcvd",
          "pdng",
          "rjct",
          "canc",
          "acfc",
          "patc",
          "part"
        ],
        "type": "string",
        "example": "accc",
        "x-enumDescriptions": {
          "accc": "`AcceptedSettlementCompleted` - Settlement on the creditor account has been completed.",
          "accp": "`AcceptedCustomerProfile` - Preceding check of technical validation was successful. Customer profile check was also successful.",
          "acsc": "`AcceptedSettlementCompleted` - Settlement on the debtor account has been completed.\r\n            \r\n\r\n            Usage: this can be used by the first agent to report to the debtor that the transaction has been completed.\r\n            Warning: this status is provided for transaction status reasons, not for financial information.\r\n            It can only be used after bilateral agreement.",
          "acsp": "`AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.",
          "actc": "`AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.",
          "acwc": "`AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.",
          "acwp": "`AcceptedWithoutPosting` - Payment instruction included in the credit transfer is accepted without being posted to the creditor customers account.",
          "rcvd": "`Received` - Payment initiation has been received by the receiving agent.",
          "pdng": "`Pending` - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.",
          "rjct": "`Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.",
          "canc": "`Cancelled` - Payment initiation has been cancelled before execution",
          "acfc": "`AcceptedFundsChecked` - Preceding check of technical validation and customer profile was successful and an automatic funds check was positive .",
          "patc": "`PartiallyAcceptedTechnicalCorrect` - The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful.",
          "part": "`PartiallyAccepted` - A number of transactions have been accepted, whereas another number of transactions have not yet achieved `accepted` status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected."
        }
      },
      "TransactionType": {
        "enum": [
          "credit",
          "debit"
        ],
        "type": "string",
        "example": "credit"
      },
      "TransactionsResponse": {
        "type": "object",
        "properties": {
          "account": {
            "$ref": "#/components/schemas/AccountReference"
          },
          "transactions": {
            "$ref": "#/components/schemas/AccountReport"
          }
        },
        "additionalProperties": false,
        "description": "Response containing account transaction data."
      }
    },
    "securitySchemes": {
      "Api access": {
        "type": "oauth2",
        "flows": {
          "password": {
            "tokenUrl": "https://id.aritma.localhost/connect/token",
            "scopes": {
              "services.banking": "Grants access to banking service",
              "api": "Grants client access to the api"
            }
          },
          "clientCredentials": {
            "tokenUrl": "https://id.aritma.localhost/connect/token",
            "scopes": {
              "services.banking": "Grants access to banking service",
              "api": "Grants client access to the api"
            }
          }
        }
      },
      "User access": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://id.aritma.localhost/connect/authorize",
            "tokenUrl": "https://id.aritma.localhost/connect/token",
            "scopes": {
              "services.banking": "Grants access to banking service"
            }
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Accounts",
      "description": "Read account information.\r\nProvides access to account lists, account details, balances and transaction information."
    },
    {
      "name": "Banks",
      "description": "Access information about the available banks."
    },
    {
      "name": "Consents",
      "description": "Obtaining a consent is the first thing you need to do in order to access bank information.\r\n            \r\nStart by sending a request to the create consent endpoint which will return a link you can redirect the user to.\r\nWhen the user visits the link, we will gather the necessary information needed to obtain a consent linked to the chosen bank.\r\n            \r\nWhen a consent has been obtained you can use it to access data through the available endpoints,\r\nkeep in mind that a consent can potentially be withdrawn by the user at any point."
    },
    {
      "name": "Payments"
    },
    {
      "name": "SigningBaskets",
      "description": "A signing basket groups multiple payments for authorisation with a single SCA operation.\r\nThe basket can contain both bulk payments and individual payment lines, each with different\r\nauthorisation requirements. Payments are exported to bank as soon as their authorisation\r\nrequirements are fulfilled, even if other payments in the basket are still pending."
    }
  ]
}