{ "openapi": "3.0.0", "info": { "title": "Open-Banking REST API", "description": "## General considerations\n\n### Pagination\n\nAll the APIs that retrieve a set of entities return a paginated result. To handle pagination you can use two parameters:\n\n* `page=n` indicates the page number you want to get\n* `itemsPerPage=m` number of items per page (30 is the default value, 100 is the maximum)\n\nFor example:\n\n`GET /business-registry/a_fiscal_code/transactions?page=2&itemsPerPage=10`\n\nTo get full information about the pagination you can send the HTTP header `application/ld+json`. You will receive an enriched payload that encapsulates the original result adding these keys:\n\n- `hydra:member` - the array with the retrieved items\n- `hydra:totalItems` - total filtered items\n- `hydra:view`\n - `hydra:first` - URL to the first page\n - `hydra:last` - URL to the last page\n - `hydra:next` - URL to the next page\n- `hydra:search` - object containing information about the filters\n\nFor example\n```json\n{\n \"@context\": \"/contexts/BusinessRegistry\",\n \"@id\": \"/business-registry\",\n \"@type\": \"hydra:Collection\",\n \"hydra:member\": [\n {\n \"@type\": \"BusinessRegistry\",\n \"@id\": \"/business-registry/EFGH\",\n \"fiscalId\": \"EFGH\",\n \"email\": \"foo2@bar.com\",\n \"businessName\": \"Foo two\",\n \"enabled\": true\n }\n ],\n \"hydra:totalItems\": 3,\n \"hydra:view\": {\n \"@id\": \"/business-registry?itemsPerPage=1&page=2\",\n \"@type\": \"hydra:PartialCollectionView\",\n \"hydra:first\": \"/business-registry?itemsPerPage=1&page=1\",\n \"hydra:last\": \"/business-registry?itemsPerPage=1&page=3\",\n \"hydra:previous\": \"/business-registry?itemsPerPage=1&page=1\",\n \"hydra:next\": \"/business-registry?itemsPerPage=1&page=3\"\n }\n}\n```\nSee [Hydra specifications](https://www.hydra-cg.com/spec/latest/core/) for more information.\n\n### Optional values\n\nOur API does not return optional values if they are not present. For example, iban, bban and swift codes are not mandatory for Accounts, \nso the JSON representation for entities that do not have these values will not contain these fields at all:\n```json\n{\n \"uuid\": \"ad82d5c8-1d05-47eb-8696-3def0bc19243\",\n \"fiscalId\": \"xxxyyyyzzz\",\n \"accountId\": \"12345678\",\n \"providerName\": \"My Bank\",\n \"name\": \"John Smith\",\n \"nature\": \"card\",\n \"balance\": \"100.00\",\n \"currencyCode\": \"USD\",\n \"enabled\": true,\n \"consentExpiresAt\": \"2019-08-24T14:15:22Z\",\n}\n```\n\n### Filtering data\n\n#### Searching for multiple values\n\nSome endpoints have query parameters of the form `someName[]`. That means you can filter data for multiple values of the parameter. \nFor example: \n```\n/sample_endpoint?sampleParameter[]=SAMPLE_1&sampleParameter[]=SAMPLE_2\n```\n\nIn this example we will get elements having `sampleParameter=SAMPLE_1` or `sampleParameter=SAMPLE_2`.\n\n#### Filtering using dates\n\nSome endpoints can use filters on dates. This kind of filter have this form:\n```\nsomeDate[before]\t\nsomeDate[strictly_before]\nsomeDate[after]\nsomeDate[strictly_after]\n```\n\nHere is an example on how to get data in some range:\n```\n/sample_endpoint?someDate[strictly_after]=2022-01-03T02:03:24Z&someDate[strictly_before]2023-11-22T04:03:15Z\n```\n\n## Using sub-accounts\n\nIf you want to have different sets of email/password so that a particular Business Registry can handle just its data, \nmaybe because you are developing an 'on premise' software, you can use sub-accounts. To do that you can create a new Business Registry,\nthen you can assign it a user (i.e. a sub-account) with a particular password with a POST on the [/business-registry/{fiscalId}/user](@site/docs/api/openbanking/post-business-registry-user.api.mdx) endpoint.\nYou can remove this assignment with a DELETE on the same endpoint. \nConnecting using the Business Registry email and the above password gives access just to data owned by this Business Registry. \nYour main login can still access data from all the Business Registries you created. \nAnother way of creating a sub account that is equivalent to the previous one is via [the authentication API](@site/docs/api/common/post-account-user-collection.api.mdx).\n\n## Using Bank Managers\n\n[Bank Managers entities](@site/docs/api/openbanking/get-bank-manager-collection.api.mdx) represent persons that have access to bank accounts owned by different Business Registries.\nExplicit creation of Bank Managers is not mandatory for using the APIs. In fact, each time a [connection request](@site/docs/api/openbanking/post-connect-request.api.mdx) is made, a default Bank Manager is created (if one does not exist).\nPlease note that in the above API you can optionally specify the [email of a Bank Manager](@site/docs/api/openbanking/post-connect-request.api.mdx) that will connect bank accounts.\nYou can also [link a new Bank Manager the Business Registry](@site/docs/api/openbanking/post-bank-manager-business-registry-item.api.mdx), hereby granting them permission to assign Accounts to it.\n\n---", "version": "20250519" }, "servers": [ { "url": "https://ob-sandbox.api.acubeapi.com", "description": "A-Cube Open Banking API sandbox environment" }, { "url": "https://ob.api.acubeapi.com", "description": "A-Cube Open Banking production environment", "x-production": "hide" } ], "security": [ { "Bearer": [] } ], "tags": [], "paths": { "/accounts/{uuid}": { "get": { "operationId": "getAccountItem", "tags": [ "Account" ], "responses": { "200": { "description": "Account resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account.AccountOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Account.AccountOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves an Account", "description": "Retrieves an Account - Please note that `extra` fields are optional and can differ between financial institutions.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putAccountItem", "tags": [ "Account" ], "responses": { "200": { "description": "Account resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account.AccountOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Account.AccountOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity" } }, "summary": "Enables/Disables an Account", "description": "Enables/Disables an Account. Disabling an account also clears its balance, extra data and transactions.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Account resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account.AccountInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Account.AccountInput.jsonld" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteAccountItem", "tags": [ "Account" ], "responses": { "202": { "description": "Account resource deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account.AccountRemoveOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Account.AccountRemoveOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Deletes an Account", "description": "The action will delete the requested account and all the other associated to the same bank connection. All the accounts must be deactivated and have no payments linked to them.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/accounts/{uuid}/reconnect": { "get": { "operationId": "reconnectAccountItem", "tags": [ "Account" ], "responses": { "200": { "description": "Account resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account.ReconnectRequestOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Account.ReconnectRequestOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Starts reconnection process for an Account", "description": "This API starts the reconnection process for an account and for all the other accounts coming from the same financial institution. \n Reconnection is needed after 90 days days from the first connection to renew consent to read financial data.\n During this process the user will be redirected to a page where it will be possible to select reconnection options. \n Please note that `extra` fields are optional and can differ between financial institutions.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank-managers": { "get": { "operationId": "getBankManagerCollection", "tags": [ "BankManager" ], "responses": { "200": { "description": "BankManager collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankManager.BankManagerOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/BankManager.BankManagerOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Retrieves the collection of BankManager resources.", "description": "Retrieves the collection of BankManager resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postBankManagerItem", "tags": [ "BankManager" ], "responses": { "201": { "description": "BankManager resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankManager.BankManagerOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BankManager.BankManagerOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a BankManager resource.", "description": "Creates a BankManager resource.", "parameters": [], "requestBody": { "description": "The new BankManager resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankManager.BankManagerCreateInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BankManager.BankManagerCreateInput.jsonld" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/bank-managers/{uuid}": { "get": { "operationId": "getBankManager", "tags": [ "BankManager" ], "responses": { "200": { "description": "BankManager resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankManager.BankManagerOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BankManager.BankManagerOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BankManager resource.", "description": "Retrieves a BankManager resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/bank-managers/{uuid}/business-registries": { "get": { "operationId": "getBankManagerBusinessRegistriesCollection", "tags": [ "BankManager" ], "responses": { "200": { "description": "BankManager collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankManager.BusinessRegistryOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/BankManager.BusinessRegistryOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Lists all the Business Registries linked to the Bank Manager", "description": "Lists all the Business Registries linked to the Bank Manager", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/business-registry": { "get": { "operationId": "getBusinessRegistryCollection", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Retrieves the collection of BusinessRegistry resources.", "description": "Retrieves the collection of BusinessRegistry resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postBusinessRegistryItem", "tags": [ "BusinessRegistry" ], "responses": { "201": { "description": "BusinessRegistry resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a new Business Registry (a fee will be charged)", "description": "Creates a new Business Registry (a fee will be charged).\n Please note that the default value of the `enabled` is `false`. Add an explicit setting to the payload if you prefer to create an enabled entity.", "parameters": [], "requestBody": { "description": "The new BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryInputCreate" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryInputCreate.jsonld" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}": { "get": { "operationId": "getBusinessRegistryItem", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a BusinessRegistry resource.", "description": "Retrieves a BusinessRegistry resource.", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putBusinessRegistryItem", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity" } }, "summary": "Changes a Business Registry (with the exception of e-mail).", "description": "Changes a Business Registry. Please note that it is not possible to replace the e-mail", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryInputUpdate" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryInputUpdate.jsonld" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteBusinessRegistryItem", "tags": [ "BusinessRegistry" ], "responses": { "204": { "description": "BusinessRegistry resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes a Business registry", "description": "Removal of a business registry involves deletion of data on his accounts and transactions, as well as withdrawal of consent to access the data.", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/accounts": { "get": { "operationId": "getAccountCollection", "tags": [ "Account" ], "responses": { "200": { "description": "Account collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account.AccountOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Account.AccountOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Retrieves the collection of Account resources for a given business registry.", "description": "Retrieves the collection of Account resources for a given business registry.\n You can optionally filter accounts by a single IBAN or a set of IBANs. \n For filtering multiple IBANs use this syntax \n \n /business-registry/{fiscalId}/accounts?iban[]=SAMPLE_1&iban[]=SAMPLE_2", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "enabled", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "iban", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "iban[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/bank-managers": { "get": { "operationId": "getBusinessRegistryBankManagersCollection", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRegistry.BankManagerOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRegistry.BankManagerOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Lists all the Bank Managers linked to the Business Registry", "description": "Lists all the Bank Managers linked to the Business Registry, having permissions to assign Accounts to it.", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postBankManagerBusinessRegistryItem", "tags": [ "BusinessRegistry" ], "responses": { "204": { "description": "BusinessRegistry resource created", "content": { "application/json": { "schema": {} }, "application/ld+json": { "schema": {} } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Link a new Bank Manager the Business Registry", "description": "Link a new Bank Manager the Business Registry, hereby granting them permission to assign Accounts to it.", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryBankManagerInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryBankManagerInput.jsonld" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/branding": { "get": { "operationId": "getBusinessRegistryBranding", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryBrandingOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryBrandingOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Gets branding data for a Business Registry", "description": "Gets branding data for a Business Registry", "parameters": [ { "name": "fiscalId", "in": "path", "description": "BusinessRegistry identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putBusinessRegistryBranding", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryBrandingOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryBrandingOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity" } }, "summary": "Updates branding data for a Business Registry", "description": "Updates branding data for a Business Registry..", "parameters": [ { "name": "fiscalId", "in": "path", "description": "BusinessRegistry identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryBrandingInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryBrandingInput.jsonld" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/branding/logo": { "get": { "operationId": "getBusinessRegistryBrandingLogo", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.ImageOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.ImageOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Gets the URL of the current Business Registry logo", "description": "Gets the URL of the current Business Registry logo", "parameters": [ { "name": "fiscalId", "in": "path", "description": "BusinessRegistry identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putBusinessRegistryBrandingLogo", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.ImageOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.ImageOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity" } }, "summary": "Updates the Business Registry logo", "description": "Updates the Business Registry logo. Image will be transmitted in the payload as a base64 string", "parameters": [ { "name": "fiscalId", "in": "path", "description": "BusinessRegistry identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.ImageInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.ImageInput.jsonld" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/connect": { "post": { "operationId": "postConnectRequest", "tags": [ "ConnectRequest" ], "responses": { "201": { "description": "ConnectRequest resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectRequest.ConnectRequestOutput" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Starts connection process for a business registry", "description": "This API starts the connection process for a business registry. During this process the user will be redirected to a page where it will be possible to choose the bank to connect to.", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new ConnectRequest resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectRequest.ConnectRequestInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/disable": { "post": { "operationId": "postBusinessRegistryDisable", "tags": [ "BusinessRegistry" ], "responses": { "201": { "description": "BusinessRegistry resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Disables data reading for a Business Registry (has impact on fees)", "description": "Disables data reading for a Business Registry (has impact on fees).", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new BusinessRegistry resource", "content": { "application/json": { "schema": {} }, "application/ld+json": { "schema": {} } }, "required": true }, "deprecated": false, "x-internal": true }, "parameters": [] }, "/business-registry/{fiscalId}/enable": { "post": { "operationId": "postBusinessRegistryEnable", "tags": [ "BusinessRegistry" ], "responses": { "201": { "description": "BusinessRegistry resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Enables data reading for a Business Registry (a fee will be charged)", "description": "Enables data reading for a Business Registry (a fee will be charged).", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new BusinessRegistry resource", "content": { "application/json": { "schema": {} }, "application/ld+json": { "schema": {} } }, "required": true }, "deprecated": false, "x-internal": true }, "parameters": [] }, "/business-registry/{fiscalId}/payments": { "get": { "operationId": "getPaymentCollection", "tags": [ "Payment" ], "responses": { "200": { "description": "Payment collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payment.PaymentOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Payment.PaymentOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Retrieves the collection of Payment resources for a given business registry.", "description": "IMPORTANT NOTE - If the `createdAt` filter is not explicitly set, this API will return only payments made during the current month.\n Here is an example of the `createdAt` filter. `createdAt[after]=2022-01-20`", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "account.uuid", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "account.uuid[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "system", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "system[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "createdAt[before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "createdAt[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/subscription": { "get": { "operationId": "getBusinessRegistrySubscription", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistrySubscriptionOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistrySubscriptionOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Displays status of auto-renew for subscriptions", "description": "Displays status of auto-renew for subscriptions.", "parameters": [ { "name": "fiscalId", "in": "path", "description": "BusinessRegistry identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putBusinessRegistrySubscription", "tags": [ "BusinessRegistry" ], "responses": { "200": { "description": "BusinessRegistry resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistrySubscriptionOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistrySubscriptionOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity" } }, "summary": "Enables or disables auto-renew of subscriptions", "description": "Enables or disables auto-renew of subscriptions. This feature cannot be performed by sub-accounts.", "parameters": [ { "name": "fiscalId", "in": "path", "description": "BusinessRegistry identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistrySubscriptionInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistrySubscriptionInput.jsonld" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/transactions": { "get": { "operationId": "getTransactionCollection", "tags": [ "Transaction" ], "responses": { "200": { "description": "Transaction collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction.TransactionOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction.TransactionOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Gets a list of transaction. Note that `pending` transactions should be deleted at each call, since they attributes (included the ID) may vary.", "description": "Please note that `extra` fields are optional and can differ between financial institutions.\n IMPORTANT NOTE - If the `madeOn` or the `updatedAt` filters are not explicitly set, \n this API will return only transactions made during the current month, i.e. an automatic filter on `madeOn` will be applied .\n Here is an example of the `madeOn` filter: `madeOn[after]=2022-01-20`. \n And this is an example of the `updatedAt` filter: `updatedAt[strictly_after]=2022-01-30T02:03:24Z`", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "account.uuid", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "account.uuid[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "duplicated", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "status", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "status[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "category", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "category[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "madeOn[before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "madeOn[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "madeOn[after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "madeOn[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "updatedAt[before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "updatedAt[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "updatedAt[after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "updatedAt[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/transactions/{transactionId}": { "get": { "operationId": "getTransactionItem", "tags": [ "Transaction" ], "responses": { "200": { "description": "Transaction resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction.TransactionOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Transaction.TransactionOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Transaction", "description": "Retrieves a Transaction - Please note that `extra` fields are optional and can differ between financial institutions.", "parameters": [ { "name": "fiscalId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false }, { "name": "transactionId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/business-registry/{fiscalId}/user": { "post": { "operationId": "postBusinessRegistryUser", "tags": [ "BusinessRegistry" ], "responses": { "204": { "description": "BusinessRegistry resource created", "content": { "application/json": { "schema": {} }, "application/ld+json": { "schema": {} } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a new user sub account for the business registry", "description": "Creates a new user sub account for the business registry. \n See also [the authentication documentation](@site/docs/api/common/post-account-user-collection.api.mdx)", "parameters": [ { "name": "fiscalId", "in": "path", "description": "BusinessRegistry identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The new BusinessRegistry resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryUserInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/BusinessRegistry.BusinessRegistryUserInput.jsonld" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteBusinessRegistryUser", "tags": [ "BusinessRegistry" ], "responses": { "204": { "description": "BusinessRegistry resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the user sub account assignment for the business registry", "description": "Removes the user sub account assignment for the business registry", "parameters": [ { "name": "fiscalId", "in": "path", "description": "BusinessRegistry identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/categories": { "get": { "operationId": "getCategoryCollection", "tags": [ "Category" ], "responses": { "200": { "description": "Category collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category.CategoryOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Category.CategoryOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Retrieves the list of transaction categories", "description": "Retrieves the list of transaction categories", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/merchants": { "get": { "operationId": "getMerchantCollection", "tags": [ "Merchant" ], "responses": { "200": { "description": "Merchant collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Merchant.MerchantOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Merchant.MerchantOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Retrieves the list of merchants", "description": "Retrieves the list of merchants which code can appear in the extra object of some transactions", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/merchants/{merchantId}": { "get": { "operationId": "getMerchantItem", "tags": [ "Merchant" ], "responses": { "200": { "description": "Merchant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Merchant.MerchantOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Merchant.MerchantOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Merchant resource.", "description": "Retrieves a Merchant resource.", "parameters": [ { "name": "merchantId", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/payments/receive/sepa": { "post": { "operationId": "postReceiveSepaPayment", "tags": [ "Payment" ], "responses": { "201": { "description": "Payment resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.PaymentRequestOutput" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Starts process for receiving a SEPA payment on a certain account", "description": "This API starts the process for receiving a payment on a certain account through SEPA circuit.", "parameters": [], "requestBody": { "description": "The new Payment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.ReceiveSepaPaymentInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/payments/receive/sepa-instant": { "post": { "operationId": "postReceiveSepaInstantPayment", "tags": [ "Payment" ], "responses": { "201": { "description": "Payment resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.PaymentRequestOutput" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Starts process for receiving a SEPA INSTANT payment on a certain account", "description": "This API starts the process for receiving a payment on a certain account through SEPA INSTANT circuit. The maximum amount that can be received is one hundred thousand Euro.", "parameters": [], "requestBody": { "description": "The new Payment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.ReceiveSepaInstantPaymentInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/payments/send/sepa": { "post": { "operationId": "postSendSepaPayment", "tags": [ "Payment" ], "responses": { "201": { "description": "Payment resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.PaymentRequestOutput" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Starts process for sending a SEPA payment from a certain account", "description": "This API starts the process for sending a payment from a certain account through SEPA circuit.", "parameters": [], "requestBody": { "description": "The new Payment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.SendSepaPaymentInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/payments/send/sepa-instant": { "post": { "operationId": "postSendSepaInstantPayment", "tags": [ "Payment" ], "responses": { "201": { "description": "Payment resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.PaymentRequestOutput" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Starts process for sending a SEPA INSTANT payment from a certain account", "description": "This API starts the process for sending a payment from a certain account through SEPA INSTANT circuit.", "parameters": [], "requestBody": { "description": "The new Payment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.SendSepaInstantPaymentInput" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/payments/{uuid}": { "get": { "operationId": "getPaymentItem", "tags": [ "Payment" ], "responses": { "200": { "description": "Payment resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment.PaymentOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Payment.PaymentOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Payment resource.", "description": "Retrieves a Payment resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/providers": { "get": { "operationId": "getProviderCollection", "tags": [ "Provider" ], "responses": { "200": { "description": "Provider collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Provider.ProviderOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Provider.ProviderOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Provider.ProviderOutput" } } } } } }, "summary": "Retrieves the list of financial providers", "description": "Retrieves the list of of financial providers. You can filter data by country code or by part of the name.\n You can get data in CSV format by setting the `Accept` header to `text/csv`. \n Please note that in order to get the whole csv file you need to add the `pagination` query parameter, for example `/providers?pagination=false`", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "pagination", "in": "query", "description": "Enable or disable pagination", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "name", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "country", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "string" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "country[]", "in": "query", "description": "", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "allowReserved": false } ], "deprecated": false }, "parameters": [] }, "/webhooks": { "get": { "operationId": "getWebhookCollection", "tags": [ "Webhook" ], "responses": { "200": { "description": "Webhook collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } } }, "application/ld+json": { "schema": { "type": "object", "properties": { "hydra:member": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" } }, "hydra:search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } } } } } } }, "required": [ "hydra:member" ] } } } } }, "summary": "Retrieves the collection of Webhook resources.", "description": "Retrieves the collection of Webhook resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false }, "post": { "operationId": "postWebhookItem", "tags": [ "Webhook" ], "responses": { "201": { "description": "Webhook resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" } }, "summary": "Creates a Webhook resource.", "description": "Creates a Webhook resource.", "parameters": [], "requestBody": { "description": "The new Webhook resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput.jsonld" } } }, "required": true }, "deprecated": false }, "parameters": [] }, "/webhooks/{uuid}": { "get": { "operationId": "getWebhookItem", "tags": [ "Webhook" ], "responses": { "200": { "description": "Webhook resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } } } }, "404": { "description": "Resource not found" } }, "summary": "Retrieves a Webhook resource.", "description": "Retrieves a Webhook resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "put": { "operationId": "putWebhookItem", "tags": [ "Webhook" ], "responses": { "200": { "description": "Webhook resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookOutput.jsonld" } } }, "links": {} }, "400": { "description": "Invalid input" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity" } }, "summary": "Replaces the Webhook resource.", "description": "Replaces the Webhook resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false, "allowReserved": false } ], "requestBody": { "description": "The updated Webhook resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Webhook.WebhookInput.jsonld" } } }, "required": true }, "deprecated": false }, "delete": { "operationId": "deleteWebhookItem", "tags": [ "Webhook" ], "responses": { "204": { "description": "Webhook resource deleted" }, "404": { "description": "Resource not found" } }, "summary": "Removes the Webhook resource.", "description": "Removes the Webhook resource.", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false }, "parameters": [] } }, "components": { "schemas": { "Account.AccountInput": { "type": "object", "description": "", "properties": { "enabled": { "type": "boolean" } } }, "Account.AccountInput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "enabled": { "type": "boolean" } } }, "Account.AccountOutput": { "type": "object", "description": "", "properties": { "uuid": { "description": "The uuid of the account that can change when disconnecting and reconnecting the account", "type": "string" }, "fiscalId": { "type": "string" }, "accountId": { "description": "The id of the account that can change when disconnecting and reconnecting the account", "type": "string" }, "connectionId": { "type": "string" }, "providerName": { "type": "string" }, "providerCountry": { "type": "string", "nullable": true }, "name": { "type": "string" }, "nature": { "description": "The type of the account. Possible values are: account, bonus, card, checking, credit, credit_card, debit_card, ewallet, insurance, investment, loan, mortgage, savings. Note: for credit_card nature, the balance represents the sum of all negative transactions, the positive ones do not count.", "type": "string" }, "balance": { "type": "string" }, "currencyCode": { "description": "A 3 char currency code following ISO 4217 standard", "type": "string" }, "enabled": { "type": "boolean" }, "consentExpiresAt": { "type": "string", "format": "date-time" }, "iban": { "type": "string", "nullable": true }, "bban": { "type": "string", "nullable": true }, "swift": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "extra": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AccountExtra" } ], "nullable": true }, "systems": { "type": "array", "items": { "enum": [ "sepa", "sepa_instant", "swift" ] }, "description": "Accepted payment systems" } } }, "Account.AccountOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "description": "The uuid of the account that can change when disconnecting and reconnecting the account", "type": "string" }, "fiscalId": { "type": "string" }, "accountId": { "description": "The id of the account that can change when disconnecting and reconnecting the account", "type": "string" }, "connectionId": { "type": "string" }, "providerName": { "type": "string" }, "providerCountry": { "type": "string", "nullable": true }, "name": { "type": "string" }, "nature": { "description": "The type of the account. Possible values are: account, bonus, card, checking, credit, credit_card, debit_card, ewallet, insurance, investment, loan, mortgage, savings. Note: for credit_card nature, the balance represents the sum of all negative transactions, the positive ones do not count.", "type": "string" }, "balance": { "type": "string" }, "currencyCode": { "description": "A 3 char currency code following ISO 4217 standard", "type": "string" }, "enabled": { "type": "boolean" }, "consentExpiresAt": { "type": "string", "format": "date-time" }, "iban": { "type": "string", "nullable": true }, "bban": { "type": "string", "nullable": true }, "swift": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "extra": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AccountExtra.jsonld" } ], "nullable": true }, "systems": { "type": "array", "items": { "enum": [ "sepa", "sepa_instant", "swift" ] }, "description": "Accepted payment systems" } } }, "Account.AccountRemoveOutput": { "type": "object", "description": "", "properties": { "removedAccounts": { "type": "array", "items": { "type": "string" } } } }, "Account.AccountRemoveOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "removedAccounts": { "type": "array", "items": { "type": "string" } } } }, "Account.ReconnectRequestOutput": { "type": "object", "description": "", "properties": { "reconnectUrl": { "type": "string", "nullable": true } } }, "Account.ReconnectRequestOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "reconnectUrl": { "type": "string", "nullable": true } } }, "AccountBasicData": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "nature": { "description": "The type of the account. Possible values are: account, bonus, card, checking, credit, credit_card, debit_card, ewallet, insurance, investment, loan, mortgage, savings", "type": "string" }, "providerName": { "type": "string" } } }, "AccountBasicData.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "nature": { "description": "The type of the account. Possible values are: account, bonus, card, checking, credit, credit_card, debit_card, ewallet, insurance, investment, loan, mortgage, savings", "type": "string" }, "providerName": { "type": "string" } } }, "AccountExtra": { "type": "object", "description": "", "properties": { "accountName": { "type": "string", "nullable": true }, "assets": { "type": "array", "items": { "type": "string" }, "nullable": true }, "availableAmount": { "type": "number", "nullable": true }, "balanceType": { "description": "The value is specific to the financial institution and can vary depending on the API standard, the bank’s implementation, \n the account’s type, country/region peculiarities, etc. This field holds an informative meaning. \n Usually, it is used to verify the balance consistency between customers of the same bank or between banks within the same country.\n Examples: interimAvailable, closingBooked, interimBooked, authorised, expected, BOOKED, CLAV, CLBD, XPCD, OTHR, etc.", "type": "string", "nullable": true }, "blockedAmount": { "type": "number", "nullable": true }, "cardType": { "description": "Type of the card account. Possible values are: american_express, china_unionpay, diners_club, jcb, maestro, master_card, uatp, visa and mir", "type": "string", "nullable": true }, "cards": { "description": "List of masked card numbers", "type": "array", "items": { "type": "string" }, "nullable": true }, "clientName": { "type": "string", "nullable": true }, "closingBalance": { "description": "Account balance at the end of the accounting period", "type": "number", "nullable": true }, "creditLimit": { "type": "number", "nullable": true }, "currentDate": { "type": "string", "nullable": true }, "currentTime": { "type": "string", "nullable": true }, "expiryDate": { "type": "string", "nullable": true }, "interestRate": { "type": "number", "nullable": true }, "interestType": { "type": "string", "nullable": true }, "floatingInterestRate": { "type": "array", "items": { "type": "string" }, "nullable": true }, "remainingPayments": { "type": "number", "nullable": true }, "penaltyAmount": { "type": "number", "nullable": true }, "nextPaymentAmount": { "type": "number", "nullable": true }, "nextPaymentDate": { "type": "string", "nullable": true }, "openDate": { "type": "string", "nullable": true }, "openingBalance": { "description": "Account balance that is brought forward from the end of one accounting period to the beginning of a new accounting period", "type": "number", "nullable": true }, "partial": { "type": "boolean", "nullable": true }, "rawBalance": { "type": "string", "nullable": true }, "sortCode": { "type": "string", "nullable": true }, "statementCutDate": { "type": "string", "nullable": true }, "status": { "description": "Shows whether the account is active or inactive", "type": "string", "nullable": true }, "totalPaymentAmount": { "type": "number", "nullable": true }, "transactionsCount": { "type": "object", "example": "{\"posted\": 12, \"pending\": 0}", "description": "Number of transactions, separated by posted and pending. e.g. {'posted': 12, 'pending': 0}", "items": { "type": "string" }, "nullable": true }, "paymentType": { "type": "string", "nullable": true }, "cashbackAmount": { "type": "number", "nullable": true }, "unitPrice": { "type": "number", "nullable": true }, "units": { "type": "number", "nullable": true }, "indicativeUnitPrice": { "type": "number", "nullable": true }, "interestIncome": { "type": "number", "nullable": true }, "interestAmount": { "type": "number", "nullable": true }, "fundHoldings": { "type": "array", "items": { "type": "string" }, "nullable": true }, "premiumFrequency": { "type": "string", "nullable": true }, "policyStatus": { "type": "string", "nullable": true }, "premiumAmount": { "type": "number", "nullable": true }, "financialConsultant": { "type": "string", "nullable": true }, "totalReversionaryBonus": { "type": "number", "nullable": true }, "grossSurrender": { "type": "number", "nullable": true }, "guaranteedGrossSurrender": { "type": "number", "nullable": true }, "reversionaryBonusCashValue": { "type": "number", "nullable": true }, "ownedPolicyAmount": { "type": "number", "nullable": true }, "policyLoanLimit": { "type": "number", "nullable": true }, "policyConvertedToPaidUp": { "type": "number", "nullable": true }, "paidUpConversionReversionaryBonus": { "type": "number", "nullable": true }, "policyComponents": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, "AccountExtra.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "accountName": { "type": "string", "nullable": true }, "assets": { "type": "array", "items": { "type": "string" }, "nullable": true }, "availableAmount": { "type": "number", "nullable": true }, "balanceType": { "description": "The value is specific to the financial institution and can vary depending on the API standard, the bank’s implementation, \n the account’s type, country/region peculiarities, etc. This field holds an informative meaning. \n Usually, it is used to verify the balance consistency between customers of the same bank or between banks within the same country.\n Examples: interimAvailable, closingBooked, interimBooked, authorised, expected, BOOKED, CLAV, CLBD, XPCD, OTHR, etc.", "type": "string", "nullable": true }, "blockedAmount": { "type": "number", "nullable": true }, "cardType": { "description": "Type of the card account. Possible values are: american_express, china_unionpay, diners_club, jcb, maestro, master_card, uatp, visa and mir", "type": "string", "nullable": true }, "cards": { "description": "List of masked card numbers", "type": "array", "items": { "type": "string" }, "nullable": true }, "clientName": { "type": "string", "nullable": true }, "closingBalance": { "description": "Account balance at the end of the accounting period", "type": "number", "nullable": true }, "creditLimit": { "type": "number", "nullable": true }, "currentDate": { "type": "string", "nullable": true }, "currentTime": { "type": "string", "nullable": true }, "expiryDate": { "type": "string", "nullable": true }, "interestRate": { "type": "number", "nullable": true }, "interestType": { "type": "string", "nullable": true }, "floatingInterestRate": { "type": "array", "items": { "type": "string" }, "nullable": true }, "remainingPayments": { "type": "number", "nullable": true }, "penaltyAmount": { "type": "number", "nullable": true }, "nextPaymentAmount": { "type": "number", "nullable": true }, "nextPaymentDate": { "type": "string", "nullable": true }, "openDate": { "type": "string", "nullable": true }, "openingBalance": { "description": "Account balance that is brought forward from the end of one accounting period to the beginning of a new accounting period", "type": "number", "nullable": true }, "partial": { "type": "boolean", "nullable": true }, "rawBalance": { "type": "string", "nullable": true }, "sortCode": { "type": "string", "nullable": true }, "statementCutDate": { "type": "string", "nullable": true }, "status": { "description": "Shows whether the account is active or inactive", "type": "string", "nullable": true }, "totalPaymentAmount": { "type": "number", "nullable": true }, "transactionsCount": { "type": "object", "example": "{\"posted\": 12, \"pending\": 0}", "description": "Number of transactions, separated by posted and pending. e.g. {'posted': 12, 'pending': 0}", "items": { "type": "string" }, "nullable": true }, "paymentType": { "type": "string", "nullable": true }, "cashbackAmount": { "type": "number", "nullable": true }, "unitPrice": { "type": "number", "nullable": true }, "units": { "type": "number", "nullable": true }, "indicativeUnitPrice": { "type": "number", "nullable": true }, "interestIncome": { "type": "number", "nullable": true }, "interestAmount": { "type": "number", "nullable": true }, "fundHoldings": { "type": "array", "items": { "type": "string" }, "nullable": true }, "premiumFrequency": { "type": "string", "nullable": true }, "policyStatus": { "type": "string", "nullable": true }, "premiumAmount": { "type": "number", "nullable": true }, "financialConsultant": { "type": "string", "nullable": true }, "totalReversionaryBonus": { "type": "number", "nullable": true }, "grossSurrender": { "type": "number", "nullable": true }, "guaranteedGrossSurrender": { "type": "number", "nullable": true }, "reversionaryBonusCashValue": { "type": "number", "nullable": true }, "ownedPolicyAmount": { "type": "number", "nullable": true }, "policyLoanLimit": { "type": "number", "nullable": true }, "policyConvertedToPaidUp": { "type": "number", "nullable": true }, "paidUpConversionReversionaryBonus": { "type": "number", "nullable": true }, "policyComponents": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, "ArrayObject": { "type": "object", "description": "", "properties": { "arrayCopy": { "readOnly": true }, "flags": { "type": "integer" }, "iterator": { "readOnly": true }, "iteratorClass": { "type": "string" } } }, "ArrayObject.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "arrayCopy": { "readOnly": true }, "flags": { "type": "integer" }, "iterator": { "readOnly": true }, "iteratorClass": { "type": "string" } } }, "BankManager.BankManagerCreateInput": { "type": "object", "description": "", "required": [ "name", "email" ], "properties": { "name": { "type": "string" }, "email": { "format": "email", "description": "It is not possible to use the same email for two different bank managers", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" } } }, "BankManager.BankManagerCreateInput.jsonld": { "type": "object", "description": "", "required": [ "name", "email" ], "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "name": { "type": "string" }, "email": { "format": "email", "description": "It is not possible to use the same email for two different bank managers", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" } } }, "BankManager.BankManagerOutput": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "BankManager.BankManagerOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "BankManager.BusinessRegistryOutput": { "type": "object", "description": "", "properties": { "fiscalId": { "type": "string" }, "email": { "type": "string" }, "businessName": { "type": "string" }, "enabled": { "type": "boolean", "example": false }, "emailAlerts": { "type": "boolean" }, "locale": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "subAccountId": { "description": "The id of the user sub account created with [POST /business-registry/{fiscalId}/user](@site/docs/api/openbanking/post-business-registry-user.api.mdx)", "type": "integer", "nullable": true } } }, "BankManager.BusinessRegistryOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "fiscalId": { "type": "string" }, "email": { "type": "string" }, "businessName": { "type": "string" }, "enabled": { "type": "boolean", "example": false }, "emailAlerts": { "type": "boolean" }, "locale": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "subAccountId": { "description": "The id of the user sub account created with [POST /business-registry/{fiscalId}/user](@site/docs/api/openbanking/post-business-registry-user.api.mdx)", "type": "integer", "nullable": true } } }, "BusinessRegistry.BankManagerOutput": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "BusinessRegistry.BankManagerOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "BusinessRegistry.BusinessRegistryBankManagerInput": { "type": "object", "description": "", "required": [ "email" ], "properties": { "email": { "format": "email", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" } } }, "BusinessRegistry.BusinessRegistryBankManagerInput.jsonld": { "type": "object", "description": "", "required": [ "email" ], "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "email": { "format": "email", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" } } }, "BusinessRegistry.BusinessRegistryBrandingInput": { "type": "object", "description": "", "properties": { "brandName": { "description": "Brand name, it can be omitted when updating data", "type": "string", "nullable": true }, "contactEmail": { "format": "email", "description": "E-mail that will be displayed on documents", "externalDocs": { "url": "http://schema.org/email" }, "type": "string", "nullable": true }, "contactPhone": { "description": "Contact phone, it can be omitted when updating data", "type": "string", "nullable": true } } }, "BusinessRegistry.BusinessRegistryBrandingInput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "brandName": { "description": "Brand name, it can be omitted when updating data", "type": "string", "nullable": true }, "contactEmail": { "format": "email", "description": "E-mail that will be displayed on documents", "externalDocs": { "url": "http://schema.org/email" }, "type": "string", "nullable": true }, "contactPhone": { "description": "Contact phone, it can be omitted when updating data", "type": "string", "nullable": true } } }, "BusinessRegistry.BusinessRegistryBrandingOutput": { "type": "object", "description": "", "properties": { "brandName": { "description": "Brand name, it can be omitted when updating data", "type": "string", "nullable": true }, "contactEmail": { "format": "email", "description": "E-mail that will be displayed on documents", "externalDocs": { "url": "http://schema.org/email" }, "type": "string", "nullable": true }, "contactPhone": { "description": "Contact phone, it can be omitted when updating data", "type": "string", "nullable": true } } }, "BusinessRegistry.BusinessRegistryBrandingOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "brandName": { "description": "Brand name, it can be omitted when updating data", "type": "string", "nullable": true }, "contactEmail": { "format": "email", "description": "E-mail that will be displayed on documents", "externalDocs": { "url": "http://schema.org/email" }, "type": "string", "nullable": true }, "contactPhone": { "description": "Contact phone, it can be omitted when updating data", "type": "string", "nullable": true } } }, "BusinessRegistry.BusinessRegistryInputCreate": { "type": "object", "description": "", "required": [ "fiscalId", "businessName", "email" ], "properties": { "fiscalId": { "minLength": 1, "maxLength": 32, "pattern": "^([a-zA-Z0-9\\-]+)$", "type": "string" }, "businessName": { "description": "Business name, it cannot be omitted when creating data", "type": "string" }, "email": { "format": "email", "description": "It is not possible to use the same email for two different business registries", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" }, "emailAlerts": { "description": "If set to true an email will be sent automatically to this business registry when a connect URL is requested and every time a reconnect will be necessary", "type": "boolean", "nullable": true }, "locale": { "type": "string", "example": "it", "description": "A valid ISO 639-1 locale code. It will be used as a default language for presenting data to the user. Possible values are: bg, cz, de, en, es-MX, es, fi, fr, he, hr, hu, it, nl, pl, pt-BR, pt, ro, ru, si, sk, tr, uk, zh-HK(Traditional), zh(Simplified). Defaults to en.", "nullable": true }, "country": { "type": "string", "example": "IT", "description": "A valid ISO-3166-1 Alpha-2 code (https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes). Financial institutions listed during connection will be filtered using this parameter.", "nullable": true }, "enabled": { "type": "boolean", "nullable": true } } }, "BusinessRegistry.BusinessRegistryInputCreate.jsonld": { "type": "object", "description": "", "required": [ "fiscalId", "businessName", "email" ], "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "fiscalId": { "minLength": 1, "maxLength": 32, "pattern": "^([a-zA-Z0-9\\-]+)$", "type": "string" }, "businessName": { "description": "Business name, it cannot be omitted when creating data", "type": "string" }, "email": { "format": "email", "description": "It is not possible to use the same email for two different business registries", "externalDocs": { "url": "http://schema.org/email" }, "type": "string" }, "emailAlerts": { "description": "If set to true an email will be sent automatically to this business registry when a connect URL is requested and every time a reconnect will be necessary", "type": "boolean", "nullable": true }, "locale": { "type": "string", "example": "it", "description": "A valid ISO 639-1 locale code. It will be used as a default language for presenting data to the user. Possible values are: bg, cz, de, en, es-MX, es, fi, fr, he, hr, hu, it, nl, pl, pt-BR, pt, ro, ru, si, sk, tr, uk, zh-HK(Traditional), zh(Simplified). Defaults to en.", "nullable": true }, "country": { "type": "string", "example": "IT", "description": "A valid ISO-3166-1 Alpha-2 code (https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes). Financial institutions listed during connection will be filtered using this parameter.", "nullable": true }, "enabled": { "type": "boolean", "nullable": true } } }, "BusinessRegistry.BusinessRegistryInputUpdate": { "type": "object", "description": "", "properties": { "businessName": { "description": "Business name, it can be omitted when updating data", "type": "string" }, "emailAlerts": { "description": "If set to true an email will be sent automatically to this business registry when a connect URL is requested and every time a reconnect will be necessary", "type": "boolean", "nullable": true }, "locale": { "type": "string", "example": "it", "description": "A valid ISO 639-1 locale code. It will be used as a default language for presenting data to the user. Possible values are: bg, cz, de, en, es-MX, es, fi, fr, he, hr, hu, it, nl, pl, pt-BR, pt, ro, ru, si, sk, tr, uk, zh-HK(Traditional), zh(Simplified). Defaults to en.", "nullable": true }, "country": { "type": "string", "example": "IT", "description": "A valid ISO-3166-1 Alpha-2 code (https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes). Financial institutions listed during connection will be filtered using this parameter.", "nullable": true }, "enabled": { "type": "boolean", "nullable": true } } }, "BusinessRegistry.BusinessRegistryInputUpdate.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "businessName": { "description": "Business name, it can be omitted when updating data", "type": "string" }, "emailAlerts": { "description": "If set to true an email will be sent automatically to this business registry when a connect URL is requested and every time a reconnect will be necessary", "type": "boolean", "nullable": true }, "locale": { "type": "string", "example": "it", "description": "A valid ISO 639-1 locale code. It will be used as a default language for presenting data to the user. Possible values are: bg, cz, de, en, es-MX, es, fi, fr, he, hr, hu, it, nl, pl, pt-BR, pt, ro, ru, si, sk, tr, uk, zh-HK(Traditional), zh(Simplified). Defaults to en.", "nullable": true }, "country": { "type": "string", "example": "IT", "description": "A valid ISO-3166-1 Alpha-2 code (https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes). Financial institutions listed during connection will be filtered using this parameter.", "nullable": true }, "enabled": { "type": "boolean", "nullable": true } } }, "BusinessRegistry.BusinessRegistryOutput": { "type": "object", "description": "", "properties": { "fiscalId": { "type": "string" }, "email": { "type": "string" }, "businessName": { "type": "string" }, "enabled": { "type": "boolean", "example": false }, "emailAlerts": { "type": "boolean" }, "locale": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "subAccountId": { "description": "The id of the user sub account created with [POST /business-registry/{fiscalId}/user](@site/docs/api/openbanking/post-business-registry-user.api.mdx)", "type": "integer", "nullable": true } } }, "BusinessRegistry.BusinessRegistryOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "fiscalId": { "type": "string" }, "email": { "type": "string" }, "businessName": { "type": "string" }, "enabled": { "type": "boolean", "example": false }, "emailAlerts": { "type": "boolean" }, "locale": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "subAccountId": { "description": "The id of the user sub account created with [POST /business-registry/{fiscalId}/user](@site/docs/api/openbanking/post-business-registry-user.api.mdx)", "type": "integer", "nullable": true } } }, "BusinessRegistry.BusinessRegistrySubscriptionInput": { "type": "object", "description": "", "properties": { "autoRenew": { "type": "boolean" } } }, "BusinessRegistry.BusinessRegistrySubscriptionInput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "autoRenew": { "type": "boolean" } } }, "BusinessRegistry.BusinessRegistrySubscriptionOutput": { "type": "object", "description": "", "properties": { "autoRenew": { "type": "boolean" } } }, "BusinessRegistry.BusinessRegistrySubscriptionOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "autoRenew": { "type": "boolean" } } }, "BusinessRegistry.BusinessRegistryUserInput": { "type": "object", "description": "", "required": [ "password" ], "properties": { "password": { "pattern": "^((?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*])(?=.{10,}).*)$", "description": "The new user password", "type": "string" } } }, "BusinessRegistry.BusinessRegistryUserInput.jsonld": { "type": "object", "description": "", "required": [ "password" ], "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "password": { "pattern": "^((?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*])(?=.{10,}).*)$", "description": "The new user password", "type": "string" } } }, "BusinessRegistry.ImageInput": { "type": "object", "description": "", "properties": { "data": { "description": "Image encoded in base64", "type": "string", "nullable": true } } }, "BusinessRegistry.ImageInput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "data": { "description": "Image encoded in base64", "type": "string", "nullable": true } } }, "BusinessRegistry.ImageOutput": { "type": "object", "description": "", "properties": { "url": { "description": "URL of the image", "type": "string", "nullable": true } } }, "BusinessRegistry.ImageOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "url": { "description": "URL of the image", "type": "string", "nullable": true } } }, "Category.CategoryOutput": { "type": "object", "description": "", "properties": { "category": { "type": "string" } } }, "Category.CategoryOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "category": { "type": "string" } } }, "ConnectRequest.ConnectRequestInput": { "type": "object", "description": "", "properties": { "locale": { "type": "string", "example": "it", "description": "A valid ISO 639-1 locale code, possible values are: bg, cz, de, en, es-MX, es, fi, fr, he, hr, hu, it, nl, pl, pt-BR, pt, ro, ru, si, sk, tr, uk, zh-HK(Traditional), zh(Simplified). Defaults to en.", "nullable": true }, "country": { "oneOf": [ { "enum": [ "XF" ] } ], "type": "string", "example": "IT", "description": "This value limits the list of selectable banks to the chosen country. It is a valid ISO-3166-1 Alpha-2 code (https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) or the fake XF country for tests in sandbox", "nullable": true }, "days": { "minimum": 1, "maximum": 180, "type": "integer", "example": 180, "description": "Number of days for which to grant consent (between 1 and 180). If you omit this parameter the maximum value will be assumed.", "nullable": true }, "returnUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to return to after a connection", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "bankManagerEmail": { "format": "email", "type": "string", "example": "accounting@example.com", "description": "Optional email of the bank manager that will connect bank accounts to this Business Registry", "externalDocs": { "url": "http://schema.org/email" }, "nullable": true } } }, "ConnectRequest.ConnectRequestOutput": { "type": "object", "description": "", "properties": { "connectUrl": { "type": "string", "nullable": true } } }, "Merchant.MerchantOutput": { "type": "object", "description": "", "properties": { "merchantId": { "type": "string" }, "name": { "type": "string" } } }, "Merchant.MerchantOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "merchantId": { "type": "string" }, "name": { "type": "string" } } }, "Payment.PaymentOutput": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "direction": { "type": "string", "example": "inbound", "description": "Direction of the payment (inbound or outbound). For inbound payments the involved account receives money, otherwise it sends money" }, "status": { "type": "string" }, "system": { "enum": [ "sepa", "sepa_instant", "swift" ], "example": "sepa", "description": "Type of payment", "type": "string" }, "amount": { "type": "string", "example": "1234.56" }, "currencyCode": { "type": "string", "example": "EUR", "description": "A three letter currency code" }, "description": { "type": "string" }, "endToEndId": { "description": "An unique payment identifier that has been sent to the financial institution", "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "debtorProviderName": { "type": "string", "nullable": true }, "account": { "$ref": "#/components/schemas/AccountBasicData" }, "extra": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/PaymentExtra" } ], "nullable": true }, "transaction": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/TransactionBasicData" } ], "nullable": true } } }, "Payment.PaymentOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "uuid": { "type": "string" }, "direction": { "type": "string", "example": "inbound", "description": "Direction of the payment (inbound or outbound). For inbound payments the involved account receives money, otherwise it sends money" }, "status": { "type": "string" }, "system": { "enum": [ "sepa", "sepa_instant", "swift" ], "example": "sepa", "description": "Type of payment", "type": "string" }, "amount": { "type": "string", "example": "1234.56" }, "currencyCode": { "type": "string", "example": "EUR", "description": "A three letter currency code" }, "description": { "type": "string" }, "endToEndId": { "description": "An unique payment identifier that has been sent to the financial institution", "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "debtorProviderName": { "type": "string", "nullable": true }, "account": { "$ref": "#/components/schemas/AccountBasicData.jsonld" }, "extra": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/PaymentExtra.jsonld" } ], "nullable": true }, "transaction": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/TransactionBasicData.jsonld" } ], "nullable": true } } }, "Payment.PaymentRequestOutput": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "connectUrl": { "type": "string" } } }, "Payment.ReceiveSepaInstantPaymentInput": { "type": "object", "description": "", "required": [ "amount", "currencyCode", "description", "accountUuid" ], "properties": { "amount": { "pattern": "^([-+]?[0-9]*\\.?[0-9]+)$", "type": "string", "example": "1234.56", "description": "The amount of the payment. Maximum value is one hundred thousand Euro" }, "currencyCode": { "enum": [ "EUR" ], "type": "string", "example": "EUR", "description": "A three letter currency code. At the moment only EUR is supported", "externalDocs": { "url": "http://schema.org/priceCurrency" } }, "description": { "pattern": "^(.{1,1000})$", "type": "string", "example": "Some description", "description": "A description at most 1000 chars long" }, "accountUuid": { "format": "uuid", "externalDocs": { "url": "http://schema.org/identifier" }, "type": "string" }, "email": { "format": "email", "type": "string", "example": "someone@mail.test", "description": "Optional e-mail of the debtor. If present, it will receive the request-to-pay link", "externalDocs": { "url": "http://schema.org/email" }, "nullable": true }, "returnUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to return to after a payment", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "errorUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to redirect to in case of an error", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "creditorIban": { "readOnly": true, "type": "string", "nullable": true }, "creditorName": { "readOnly": true, "type": "string", "nullable": true } } }, "Payment.ReceiveSepaPaymentInput": { "type": "object", "description": "", "required": [ "amount", "currencyCode", "description", "accountUuid" ], "properties": { "amount": { "pattern": "^([-+]?[0-9]*\\.?[0-9]+)$", "type": "string", "example": "1234.56" }, "currencyCode": { "enum": [ "EUR" ], "type": "string", "example": "EUR", "description": "A three letter currency code. At the moment only EUR is supported", "externalDocs": { "url": "http://schema.org/priceCurrency" } }, "description": { "pattern": "^(.{1,1000})$", "type": "string", "example": "Some description", "description": "A description at most 1000 chars long" }, "accountUuid": { "format": "uuid", "externalDocs": { "url": "http://schema.org/identifier" }, "type": "string" }, "email": { "format": "email", "type": "string", "example": "someone@mail.test", "description": "Optional e-mail of the debtor. If present, it will receive the request-to-pay link", "externalDocs": { "url": "http://schema.org/email" }, "nullable": true }, "returnUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to return to after a payment", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "errorUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to redirect to in case of an error", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "creditorIban": { "readOnly": true, "type": "string", "nullable": true }, "creditorName": { "readOnly": true, "type": "string", "nullable": true } } }, "Payment.SendSepaInstantPaymentInput": { "type": "object", "description": "", "required": [ "amount", "currencyCode", "description", "accountUuid", "creditorIban", "creditorName" ], "properties": { "amount": { "pattern": "^([-+]?[0-9]*\\.?[0-9]+)$", "type": "string" }, "currencyCode": { "enum": [ "EUR" ], "externalDocs": { "url": "http://schema.org/priceCurrency" }, "type": "string" }, "description": { "pattern": "^(.{1,1000})$", "type": "string" }, "accountUuid": { "format": "uuid", "externalDocs": { "url": "http://schema.org/identifier" }, "type": "string" }, "creditorIban": { "externalDocs": { "url": "http://schema.org/identifier" }, "type": "string", "nullable": true }, "creditorName": { "type": "string", "nullable": true }, "returnUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to return to after a payment", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "errorUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to redirect to in case of an error", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "email": { "readOnly": true, "type": "string", "nullable": true } } }, "Payment.SendSepaPaymentInput": { "type": "object", "description": "", "required": [ "amount", "currencyCode", "description", "accountUuid", "creditorIban", "creditorName" ], "properties": { "amount": { "pattern": "^([-+]?[0-9]*\\.?[0-9]+)$", "type": "string" }, "currencyCode": { "enum": [ "EUR" ], "externalDocs": { "url": "http://schema.org/priceCurrency" }, "type": "string" }, "description": { "pattern": "^(.{1,1000})$", "type": "string" }, "accountUuid": { "format": "uuid", "externalDocs": { "url": "http://schema.org/identifier" }, "type": "string" }, "creditorIban": { "externalDocs": { "url": "http://schema.org/identifier" }, "type": "string", "nullable": true }, "creditorName": { "type": "string", "nullable": true }, "returnUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to return to after a payment", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "errorUrl": { "format": "uri", "type": "string", "description": "Optional URL for the customer to redirect to in case of an error", "externalDocs": { "url": "http://schema.org/url" }, "nullable": true }, "email": { "readOnly": true, "type": "string", "nullable": true } } }, "PaymentExtra": { "type": "object", "description": "", "properties": { "paymentAttributes": { "$ref": "#/components/schemas/ArrayObject" }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentStage" } } } }, "PaymentExtra.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "paymentAttributes": { "$ref": "#/components/schemas/ArrayObject.jsonld" }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentStage.jsonld" } } } }, "PaymentStage": { "type": "object", "description": "", "properties": { "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "PaymentStage.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "Provider.ProviderOutput": { "type": "object", "description": "", "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "paymentTemplates": { "description": "A list of accepted payment methods, such as \"SEPA\" or \"SEPA_INSTANT\"", "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "maxConsentDays": { "type": "integer", "nullable": true }, "maxFetchDays": { "type": "integer", "nullable": true } } }, "Provider.ProviderOutput.jsonld": { "type": "object", "description": "", "properties": { "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "name": { "type": "string" }, "country": { "type": "string" }, "paymentTemplates": { "description": "A list of accepted payment methods, such as \"SEPA\" or \"SEPA_INSTANT\"", "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "maxConsentDays": { "type": "integer", "nullable": true }, "maxFetchDays": { "type": "integer", "nullable": true } } }, "Transaction.TransactionOutput": { "type": "object", "description": "", "properties": { "transactionId": { "description": "The id of the transaction that can change when disconnecting and reconnecting an account", "type": "string" }, "status": { "description": "Possible values are: posted, pending", "type": "string" }, "madeOn": { "type": "string", "format": "date", "description": "The date when the transaction was made" }, "amount": { "type": "string" }, "currencyCode": { "description": "A 3 char currency code following ISO 4217 standard", "type": "string" }, "description": { "type": "string" }, "additional": { "description": "An additional description for the transaction", "type": "string", "nullable": true }, "category": { "type": "string" }, "duplicated": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "description": "Time and date when the transaction was imported in our systems" }, "updatedAt": { "type": "string", "format": "date-time", "description": "The last time when the transaction’s attributes `duplicated` and `category` were changed by remote systems" }, "account": { "$ref": "#/components/schemas/AccountBasicData" }, "extra": { "$ref": "#/components/schemas/TransactionExtra" } } }, "Transaction.TransactionOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "transactionId": { "description": "The id of the transaction that can change when disconnecting and reconnecting an account", "type": "string" }, "status": { "description": "Possible values are: posted, pending", "type": "string" }, "madeOn": { "type": "string", "format": "date", "description": "The date when the transaction was made" }, "amount": { "type": "string" }, "currencyCode": { "description": "A 3 char currency code following ISO 4217 standard", "type": "string" }, "description": { "type": "string" }, "additional": { "description": "An additional description for the transaction", "type": "string", "nullable": true }, "category": { "type": "string" }, "duplicated": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "description": "Time and date when the transaction was imported in our systems" }, "updatedAt": { "type": "string", "format": "date-time", "description": "The last time when the transaction’s attributes `duplicated` and `category` were changed by remote systems" }, "account": { "$ref": "#/components/schemas/AccountBasicData.jsonld" }, "extra": { "$ref": "#/components/schemas/TransactionExtra.jsonld" } } }, "TransactionBasicData": { "type": "object", "description": "", "properties": { "transactionId": { "type": "string" }, "madeOn": { "type": "string", "format": "date" }, "amount": { "type": "string" }, "currencyCode": { "description": "A 3 char currency code following ISO 4217 standard", "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "TransactionBasicData.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "transactionId": { "type": "string" }, "madeOn": { "type": "string", "format": "date" }, "amount": { "type": "string" }, "currencyCode": { "description": "A 3 char currency code following ISO 4217 standard", "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "TransactionExtra": { "type": "object", "description": "", "properties": { "accountBalanceSnapshot": { "description": "The balance of the account at the moment when the transaction was imported by the PSD2 API, not when the transaction has been made. See `closingBalance` for that", "type": "number", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "assetAmount": { "type": "number", "nullable": true }, "assetCode": { "type": "string", "nullable": true }, "categorizationConfidence": { "description": "Value from 0 to 1, the probability that the current category is the correct one", "type": "number", "nullable": true }, "checkNumber": { "type": "string", "nullable": true }, "closingBalance": { "description": "Account balance after the transaction has been made", "type": "number", "nullable": true }, "constantCode": { "type": "string", "nullable": true }, "convert": { "type": "boolean", "nullable": true }, "customerCategoryCode": { "type": "string", "nullable": true }, "customerCategoryName": { "type": "string", "nullable": true }, "exchangeRate": { "type": "number", "nullable": true }, "id": { "type": "string", "nullable": true }, "endToEndId": { "type": "string", "nullable": true }, "information": { "type": "string", "nullable": true }, "mcc": { "type": "string", "nullable": true }, "merchantId": { "type": "string", "nullable": true }, "openingBalance": { "description": "Account balance before the transaction has been made", "type": "number", "nullable": true }, "installmentDebtAmount": { "type": "number", "nullable": true }, "originalAmount": { "type": "number", "nullable": true }, "originalCategory": { "type": "string", "nullable": true }, "originalCurrencyCode": { "type": "string", "nullable": true }, "originalSubcategory": { "type": "string", "nullable": true }, "payee": { "type": "string", "nullable": true }, "payeeInformation": { "type": "string", "nullable": true }, "payer": { "type": "string", "nullable": true }, "payerInformation": { "type": "string", "nullable": true }, "possibleDuplicate": { "type": "boolean", "nullable": true }, "postingDate": { "description": "Date when the transaction appears in statement", "type": "string", "format": "date-time", "nullable": true }, "postingTime": { "type": "string", "nullable": true }, "recordNumber": { "type": "string", "nullable": true }, "specificCode": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "time": { "type": "string", "nullable": true }, "transferAccountName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "unitPrice": { "type": "number", "nullable": true }, "units": { "type": "number", "nullable": true }, "variableCode": { "type": "string", "nullable": true } } }, "TransactionExtra.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "accountBalanceSnapshot": { "description": "The balance of the account at the moment when the transaction was imported by the PSD2 API, not when the transaction has been made. See `closingBalance` for that", "type": "number", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "assetAmount": { "type": "number", "nullable": true }, "assetCode": { "type": "string", "nullable": true }, "categorizationConfidence": { "description": "Value from 0 to 1, the probability that the current category is the correct one", "type": "number", "nullable": true }, "checkNumber": { "type": "string", "nullable": true }, "closingBalance": { "description": "Account balance after the transaction has been made", "type": "number", "nullable": true }, "constantCode": { "type": "string", "nullable": true }, "convert": { "type": "boolean", "nullable": true }, "customerCategoryCode": { "type": "string", "nullable": true }, "customerCategoryName": { "type": "string", "nullable": true }, "exchangeRate": { "type": "number", "nullable": true }, "id": { "type": "string", "nullable": true }, "endToEndId": { "type": "string", "nullable": true }, "information": { "type": "string", "nullable": true }, "mcc": { "type": "string", "nullable": true }, "merchantId": { "type": "string", "nullable": true }, "openingBalance": { "description": "Account balance before the transaction has been made", "type": "number", "nullable": true }, "installmentDebtAmount": { "type": "number", "nullable": true }, "originalAmount": { "type": "number", "nullable": true }, "originalCategory": { "type": "string", "nullable": true }, "originalCurrencyCode": { "type": "string", "nullable": true }, "originalSubcategory": { "type": "string", "nullable": true }, "payee": { "type": "string", "nullable": true }, "payeeInformation": { "type": "string", "nullable": true }, "payer": { "type": "string", "nullable": true }, "payerInformation": { "type": "string", "nullable": true }, "possibleDuplicate": { "type": "boolean", "nullable": true }, "postingDate": { "description": "Date when the transaction appears in statement", "type": "string", "format": "date-time", "nullable": true }, "postingTime": { "type": "string", "nullable": true }, "recordNumber": { "type": "string", "nullable": true }, "specificCode": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "time": { "type": "string", "nullable": true }, "transferAccountName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "unitPrice": { "type": "number", "nullable": true }, "units": { "type": "number", "nullable": true }, "variableCode": { "type": "string", "nullable": true } } }, "Webhook.WebhookInput": { "type": "object", "description": "", "required": [ "event", "targetUrl" ], "properties": { "event": { "enum": [ "connect", "reconnect", "payment" ], "type": "string" }, "targetUrl": { "format": "uri", "externalDocs": { "url": "http://schema.org/url" }, "type": "string" }, "authenticationType": { "enum": [ "query", "header" ], "type": "string", "nullable": true }, "authenticationKey": { "type": "string", "nullable": true }, "authenticationToken": { "type": "string", "nullable": true } } }, "Webhook.WebhookInput.jsonld": { "type": "object", "description": "", "required": [ "event", "targetUrl" ], "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "event": { "enum": [ "connect", "reconnect", "payment" ], "type": "string" }, "targetUrl": { "format": "uri", "externalDocs": { "url": "http://schema.org/url" }, "type": "string" }, "authenticationType": { "enum": [ "query", "header" ], "type": "string", "nullable": true }, "authenticationKey": { "type": "string", "nullable": true }, "authenticationToken": { "type": "string", "nullable": true } } }, "Webhook.WebhookOutput": { "type": "object", "description": "", "properties": { "uuid": { "type": "string" }, "event": { "enum": [ "connect", "reconnect", "payment" ], "type": "string" }, "targetUrl": { "type": "string" }, "authenticationType": { "type": "string", "nullable": true }, "authenticationKey": { "type": "string", "nullable": true }, "authenticationToken": { "type": "string", "nullable": true } } }, "Webhook.WebhookOutput.jsonld": { "type": "object", "description": "", "properties": { "@context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "readOnly": true, "type": "string" }, "@type": { "readOnly": true, "type": "string" }, "uuid": { "type": "string" }, "event": { "enum": [ "connect", "reconnect", "payment" ], "type": "string" }, "targetUrl": { "type": "string" }, "authenticationType": { "type": "string", "nullable": true }, "authenticationKey": { "type": "string", "nullable": true }, "authenticationToken": { "type": "string", "nullable": true } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Value for the Authorization header parameter.", "name": "Authorization", "in": "header" } } }, "x-tagGroups": [ { "name": "Open Banking REST API", "tags": [ "Account", "BankManager", "Category", "ConnectRequest", "BusinessRegistry", "Transaction", "Merchant", "Webhook", "Payment", "Provider" ] } ] }