openapi: 3.0.0 info: title: BANKS/Connect API Reference description: '' version: '2.0' contact: {} x-konfig-ignore: potential-incorrect-type: true servers: - url: https://banksapi.io variables: {} tags: - name: Auth - name: Customer Bank Access - name: Customer Payment - name: Providers - name: Customer Bank Access Consent - name: Customer Bank Access Payment - description: >- Legacy endpoints, that will be replaced by the endpoints in 'Customer Payment' name: Customer Ueberweisung - name: Customer Consent - name: Customer REG/Protect - name: Customer Bank Access Builder - name: Customer - name: Encrypt paths: /auth/mgmt/v1/tenants/{tenant-name}/users: post: tags: - Auth summary: Create User operationId: Auth_createTenantUser description: >- Creates a technical user corresponding (one-to-one) a tenant's user. Users are needed to use BANKSapi's core features like adding accounts or performing payments. After creating a user, they're automatically activated. parameters: - $ref: '#/components/parameters/tenant-name' requestBody: $ref: '#/components/requestBodies/CreateUser' responses: '201': description: >- Returns with a location header under which the user data can be retrieved. headers: Location: schema: type: string example: >- https://banksapi.io/auth/tenants/demo/users/8fb65b0e-9418-412d-9865-b960ef81b43f deprecated: false get: tags: - Auth summary: Get Users operationId: Auth_getActivatedUsers description: Get all activated users parameters: - $ref: '#/components/parameters/tenant-name' - description: Whether or not to also include inactive users name: includeInactive in: query schema: type: boolean example: true default: false responses: '200': description: Returns an array of User content: application/json: schema: $ref: '#/components/schemas/AuthGetActivatedUsersResponse' example: - userReference: 1c5b33f6-9c4d-11e6-ba80-480fcfb9550f username: demo-user deprecated: false /auth/oauth2/token: post: tags: - Auth summary: Create Token operationId: Auth_createToken security: - basicAuth: [] description: >- Creates a client or user token valid for 24 hours. Client tokens are needed for administrative use cases such as creating users. User tokens are needed when creating or querying banking accounts. requestBody: description: The request body contains form object with following parameters content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateToken' example: grant_type: client_credentials scope: http://banksapi.io/provider/read required: true responses: '200': description: Returns token object content: application/json: schema: $ref: '#/components/schemas/Token' example: scope: >- http://banksapi.io/customer/read http://banksapi.io/customer/modify tenant: demo client: demo-client user: 1fad71ee-6dbf-49c7-9cb2-fff588de011f additionalData: username: demouser validTo: '2021-10-16T10:46:47.000Z' access_token: 0defaced-1337-d00d-c0de-face8badcafe token_type: Bearer '401': description: >- The basic authorization header was not sent or the value was incorrect. deprecated: false /auth/mgmt/v1/tenants: get: tags: - Auth summary: Get Tenants operationId: Auth_getTenants description: Get all tenants responses: '200': description: Returns an array of Tenant content: application/json: schema: $ref: '#/components/schemas/AuthGetTenantsResponse' example: - description: A Tenant for demonstration purposes name: demo deprecated: false /auth/mgmt/v1/tenants/{tenant-name}/users/{user-id}: get: tags: - Auth summary: Get User operationId: Auth_getActivatedUser description: This function can be used to retrieve a single activated user. parameters: - $ref: '#/components/parameters/tenant-name' - $ref: '#/components/parameters/user-id' responses: '200': description: Returns a User object content: application/json: schema: $ref: '#/components/schemas/User' example: userReference: 1c5b33f6-9c4d-11e6-ba80-480fcfb9550f username: demo-user deprecated: false delete: tags: - Auth summary: Delete User operationId: Auth_deleteUser description: Deletes a single user. The user must be deactivated beforehand. parameters: - $ref: '#/components/parameters/tenant-name' - $ref: '#/components/parameters/user-id' - description: Reference type of user ID ("id" (default) or "username") name: reftype in: query schema: type: string example: username responses: '200': description: Returns HTTP status of 200 (OK) '405': description: >- Returns HTTP status of 405 (Method Not Allowed) if user has not been deactivated. put: tags: - Auth summary: Change user details operationId: Auth_changeUserDetails description: Changes user details, such as username, first name or last name parameters: - $ref: '#/components/parameters/tenant-name' - $ref: '#/components/parameters/user-id' - description: Reference type of user ID ("id" (default) or "username") name: reftype in: query schema: type: string example: username requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeUserDetails' example: username: demouser firstname: demo lastname: user responses: '200': description: Change successful '409': description: Username already exists /auth/mgmt/v1/tenants/{tenant-name}/users/{user-id}/deactivate: put: tags: - Auth summary: Deactivate User operationId: Auth_deactivateUser description: Deactivates a single user parameters: - $ref: '#/components/parameters/tenant-name' - $ref: '#/components/parameters/user-id' - description: Reference type of user ID ("id" (default) or "username") name: reftype in: query schema: type: string example: username responses: '200': description: Returns HTTP status of 200 (OK) deprecated: false /auth/mgmt/v1/tenants/{tenant-name}/users/{user-id}/reactivate: post: tags: - Auth summary: Reactivate User operationId: Auth_reactivateUser description: Reactivate a single deactivated user parameters: - $ref: '#/components/parameters/tenant-name' - $ref: '#/components/parameters/user-id' - description: Reference type of user ID ("id" (default) or "username") name: reftype in: query schema: type: string example: username requestBody: $ref: '#/components/requestBodies/CreateUser' responses: '200': description: Returns HTTP status of 200 (OK) deprecated: false /auth/oauth2/revoke: post: tags: - Auth summary: Revoke Token operationId: Auth_revokeToken security: - basicAuth: [] description: >- To revoke a token, the user token is sent to the URL `https://banksapi.io/auth/oauth2/revoke` via a POST request. requestBody: description: The request body contains form object with following parameters content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthRevokeTokenRequest' example: token: 0defaced-1337-d00d-c0de-face8badcafe required: true responses: '200': description: Returns HTTP status of 200 (OK) deprecated: false /auth/oauth2/introspect: get: tags: - Auth summary: Introspect Token operationId: Auth_tokenInfo security: [] description: Returns information about a token parameters: - description: The Token to introspect name: token in: query required: true schema: type: string format: uuid example: 0defaced-1337-d00d-c0de-face8badcafe responses: '200': description: Returns token object content: application/json: schema: $ref: '#/components/schemas/Token' example: scope: >- http://banksapi.io/customer/read http://banksapi.io/customer/modify tenant: demo client: demo-client user: CN=Demo User,OU=Personal,DC=banksapi,DC=io additionalData: username: demouser validTo: '2021-10-16T10:46:47.000Z' access_token: 0defaced-1337-d00d-c0de-face8badcafe token_type: Bearer '400': description: No token was provided. '401': description: >- The basic authorization header was not sent or the value was incorrect. '403': description: The provided token is not valid. deprecated: false /encrypt: put: tags: - Encrypt summary: Encrypt plaintexts operationId: Encrypt_plaintext description: >- Encrypt a given plaintext for the tenant identified by the given bearer token. requestBody: description: Plaintext to encrypt encoded in Base64 content: application/octet-stream+base64: schema: $ref: '#/components/schemas/EncryptPlaintextRequest' example: aGCZBgX ... 8Fi7xMQ= required: true responses: '200': description: Ciphertext (encrypted plaintext) encoded in Base64 content: application/octet-stream+base64: schema: $ref: '#/components/schemas/EncryptPlaintextResponse' example: aGCZBgX ... 8Fi7xMQ= /providers/v2: get: tags: - Providers summary: Get Providers operationId: Providers_getAll description: Retrieve a list of and information for all providers. responses: '200': description: Returns an array of providers. content: application/json: schema: $ref: '#/components/schemas/ProvidersGetAllResponse' example: - id: 00000000-0000-0000-0000-000000000000 name: Demo Provider consumerRelevant: true group: demo blz: '12345678' bic: DEMO1234 relations: - rel: self href: >- https://banksapi.io/providers/v2/00000000-0000-0000-0000-000000000000 - rel: logo href: https://banksapi.io/providers/v2/demo.svg capabilities: - KONTEN - KARTEN - DEPOTS channels: - - GIROKONTO - - KREDITKARTE - TAGESGELDKONTO authenticationInfo: loginHint: >- Der Demo Provider bietet drei Zugänge demo1/demo1, demo2/demo2 und demo3/demo3 fields: - fieldkey: userid label: Demo-User secret: false hint: demo1, demo2 oder demo3 format: ^.{1,50}$ - fieldkey: pin label: Demo-Passwort secret: true hint: demo1, demo2 oder demo3 format: ^.{1,50}$ deprecated: false /providers/v2/coredata: get: tags: - Providers summary: Get Providers core data operationId: Providers_listCoreData description: Retrieve a list of core data for all providers. parameters: - description: Filter providers by capability name: capability in: query required: false schema: type: string enum: - KONTEN - KARTEN - DEPOTS - BAUSPAR responses: '200': description: Returns an array of core data for providers. content: application/json: schema: $ref: '#/components/schemas/ProvidersListCoreDataResponse' example: - id: 00000000-0000-0000-0000-000000000000X name: Demo Provider group: demo blz: '12345678' bic: DEMO1234 logo: https://banksapi.io/providers/v2/demo.svg deprecated: false /providers/v2/statistics/jobs: get: tags: - Providers summary: Get Providers job statistics operationId: Providers_getJobStatistics description: >- Retrieve a list of provider logos with statistical data about the data jobs. If there were no successful data jobs or no data jobs at all in the specified time period, no entry is returned for the corresponding logo. parameters: - description: >- Specifies the number of past days for fetching job statistics. When used together with "hours", their values are summed. If none of the parameters are specified, 2 hours are fetched. name: days in: query required: false schema: type: integer format: int32 - description: >- Specifies the number of past hours for fetching job statistics. When used together with "days", their values are summed. If none of the parameters are specified, 2 hours are fetched. name: hours in: query required: false schema: type: integer format: int32 - description: If only EBICS jobs should be considered for the response. name: ebics in: query required: false schema: type: boolean example: false - description: >- If only provider logos with at least one job including a strong customer authentication (SCA) should be considered for the response. In case of `false` it will not be checked whether there was an SCA or not. name: sca in: query required: false schema: type: boolean example: false responses: '200': description: Returns a list of job statistics for providers. content: application/json: schema: $ref: '#/components/schemas/ProvidersGetJobStatisticsResponse' example: - logo: demo latestSuccessDate: '2023-09-20T11:21:02.000Z' averageDuration: 29962 successRate: 1 - logo: sparkasse latestSuccessDate: '2023-09-20T11:28:57.000Z' averageDuration: 54186 successRate: 0.99 deprecated: false /providers/v2/{provider-id}: get: tags: - Providers summary: Get Provider operationId: Providers_getInformation description: Retrieve information for a specific provider. parameters: - $ref: '#/components/parameters/provider-id' responses: '200': description: Returns a single provider object. content: application/json: schema: $ref: '#/components/schemas/Provider' example: id: 00000000-0000-0000-0000-000000000000X name: Demo Provider consumerRelevant: true group: demo blz: '12345678' bic: DEMO1234 relations: - rel: self href: >- https://banksapi.io/providers/v2/00000000-0000-0000-0000-000000000000 - rel: logo href: https://banksapi.io/providers/v2/demo.svg capabilities: - KONTEN - KARTEN - DEPOTS channels: - - GIROKONTO - - KREDITKARTE - TAGESGELDKONTO authenticationInfo: loginHint: >- Der Demo Provider bietet drei Zugänge demo1/demo1, demo2/demo2 und demo3/demo3 fields: - fieldkey: userid label: Demo-User secret: false hint: demo1, demo2 oder demo3 format: ^.{1,50}$ - fieldkey: pin label: Demo-Passwort secret: true hint: demo1, demo2 oder demo3 format: ^.{1,50}$ links: self: $ref: '#/components/links/self' logo: description: Provider logo in SVG format '404': description: >- If the URL does not point to a provider, you will get the HTTP status 404 (Not found). deprecated: false /providers/v2/{provider-id}/ebics: get: tags: - Providers summary: Get Provider EBICS Info operationId: Providers_getEbicsInfo description: Retrieve EBICS information for a specific provider (if available). parameters: - $ref: '#/components/parameters/provider-id' responses: '200': description: Returns an EBICS info object for a specific provider. content: application/json: schema: $ref: '#/components/schemas/ProviderEbicsInfo' example: hostId: HOSTIDXY hostUrl: https://ebics.bank.com/ebics '404': description: >- If the URL does not point to a provider, you will get the HTTP status 404 (Not found). deprecated: false /customer/v2: get: tags: - Customer summary: Get Customer operationId: Customer_getObject description: >- Retrieves the customer object for the authenticated user. It is also the entry point to the deeper functions of the interface. responses: '200': description: Returns customer object of the user. content: application/json: schema: $ref: '#/components/schemas/Customer' example: bankzugaenge: 4000fda7-18af-463f-b694-bbafe5d23a48: messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus sicherheitsverfahren: - kodierung: 980 name: mTAN hinweis: mTAN - name: SMS_OTP kodierung: '942' hinweis: SMS OTP relations: - rel: startSCA href: >- https://banksapi.io/v2/customer/consent/1345340218050910215PSDDE-BAFIN-152070CO4960JJ relations: - rel: self href: https://banksapi.io/customer/v2 - rel: get_bankzugaenge href: https://banksapi.io/customer/v2/bankzugaenge - rel: add_bankzugaenge href: https://banksapi.io/customer/v2/bankzugaenge - rel: delete_bankzugaenge href: https://banksapi.io/customer/v2/bankzugaenge links: self: $ref: '#/components/links/self' get_bankzugaenge: $ref: '#/components/links/get_bankzugaenge' add_bankzugaenge: $ref: '#/components/links/add_bankzugaenge' delete_bankzugaenge: $ref: '#/components/links/delete_bankzugaenge' delete_regprotect_sessions: $ref: '#/components/links/delete_regprotect_sessions' get_contracts: $ref: '#/components/links/get_contracts' get_sales_triggers: $ref: '#/components/links/get_sales_triggers' get_life_events: $ref: '#/components/links/get_life_events' get_life_stages: $ref: '#/components/links/get_life_stages' get_cashflow: $ref: '#/components/links/get_cashflow' get_credit_check: $ref: '#/components/links/get_credit_check' get_disposable_money: $ref: '#/components/links/get_disposable_money' get_affinities: $ref: '#/components/links/get_affinities' get_credit_attributes: $ref: '#/components/links/get_credit_attributes' get_tagging_rules: $ref: '#/components/links/get_tagging_rules' delete_tagging_rules: $ref: '#/components/links/delete_tagging_rules' add_tagging_rules: $ref: '#/components/links/add_tagging_rules' deprecated: false /customer/v2/bankzugaenge: post: tags: - Customer Bank Access summary: Add Bank Access operationId: CustomerBankAccess_addBankAccess description: Adds a bank access for the given user and set of credentials. parameters: - $ref: '#/components/parameters/customer-ip-address' - $ref: '#/components/parameters/callbackUrl' - description: >- If the bank access already exists, regardless of the **background** update, all revenues and information are retrieved by the provider, if true name: refresh in: query required: false schema: type: boolean example: false - $ref: '#/components/parameters/queryTanSettings' - description: >- Flag to solely fetch header data of the account without balances and transactions (e.g. to get the list of selectable bank products). If this flag is `true` the flag `sync` in the request payload has to be `false` and no `selectedBankProducts` can be specified. name: headOnly in: query required: false schema: type: boolean example: true - description: Indicator if transactions older than 90 days should be fetched. name: maxTransactions in: query required: false schema: $ref: '#/components/schemas/MaxTransactions' - description: >- Flag to solely fetch payment accounts. Other accounts will be ignored, which can result in fewer SCAs. name: paymentAccountsOnly in: query required: false schema: type: boolean example: true requestBody: description: >- The body contains information about the bank access. REG/Hosting tenants need to provide credentials in case this is not a "refresh"-request. In case of a REG/Protect tenant or a "refresh"-request the value for the access-id-key should be an empty object. content: application/json: schema: $ref: '#/components/schemas/CreateBankAccess' example: 815251d6-c062-4f61-bec0-182bc14a48fb: providerId: 00000000-0000-0000-0000-000000000000 credentials: userid: mOd2uKYr+2 ... TWOPCAt5zP pin: Hhnc+aW/eM ... 7F+XRSHasW sync: true selectedBankProducts: - DE00123456789012345679 required: true responses: '201': $ref: '#/components/responses/bankAccessCreated' '451': $ref: '#/components/responses/regprotect' '504': description: The started request could not be answered in the given time deprecated: false get: tags: - Customer Bank Access summary: Get Bank Accesses operationId: CustomerBankAccess_getAll description: Retrieves all bank accesses for this user. responses: '200': description: The success response contains an collection of bank accesses. headers: {} content: application/json: schema: $ref: '#/components/schemas/ListOfBankAccesses' example: 0b7f4783-4c93-4820-8e73-354a0f1c469e: id: 0b7f4783-4c93-4820-8e73-354a0f1c469e providerId: 00000000-0000-0000-0000-000000000000 aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z' tanMedien: - name: Mobil medienklasse: MOBIL gueltigVon: '2021-10-15T09:13:44.000Z' gueltigBis: '2021-10-15T09:13:44.000Z' sicherheitsverfahren: - kodierung: 1 name: mockTAN hinweis: Gib eine durch 2 teilbare Zahl ein - kodierung: 999 name: iTAN hinweis: Gib die TAN "12" an. aktivesSicherheitsverfahren: kodierung: 999 name: iTAN hinweis: Gib die TAN "12" an. relations: - rel: self href: >- https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e - rel: delete_bankzugang href: >- https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e status: VOLLSTAENDIG bankprodukte: - id: DE00123456789012345679 status: VOLLSTAENDIG bezeichnung: Tagesgeldkonto kategorie: TAGESGELDKONTO saldo: 27365.56 aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z' saldoDatum: '2021-10-15T00:00:00.000Z' waehrung: EUR kontonummer: '9012345679' iban: DE00123456789012345679 bic: XXX12345678 blz: '12345678' kreditinstitut: Demo Provider inhaber: Fritz Testmüller transferSupport: true relations: - rel: get_kontoumsaetze href: >- https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e/DE00123456789012345679/kontoumsaetze - rel: initiate_single_transfer href: >- https://banksapi.io/customer/v2/payment/single-transfer - rel: initiate_bulk_transfer href: >- https://banksapi.io/customer/v2/payment/bulk-transfer messages: [] verfuegungsrahmen: 27365.56 verfuegterBetrag: 0 sync: true 4000fda7-18af-463f-b694-bbafe5d23a48: status: VOLLSTAENDIG tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' timeout: '2016-12-24T13:37:42.000Z' messages: [] bankprodukte: [] relations: [] sync: false '401': description: >- The bearer authorization header was not sent or the value was incorrect. deprecated: false delete: tags: - Customer Bank Access summary: Delete All Bank Accesses operationId: CustomerBankAccess_removeAllBankAccesses description: Removes all bank accesses of the authenticated user. parameters: - $ref: '#/components/parameters/customer-ip-address' responses: '200': description: The HTTP status 200 returns without any further response body. deprecated: false /customer/v2/bankzugaenge/{access-id}: get: tags: - Customer Bank Access summary: Get Bank Access operationId: CustomerBankAccess_getSpecificBankAccess description: Retrieves a specific bank access for this user. parameters: - $ref: '#/components/parameters/access-id' responses: '200': description: Returns a bank access object content: application/json: schema: $ref: '#/components/schemas/BankAccess' example: status: VOLLSTAENDIG tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' timeout: '2016-12-24T13:37:42.000Z' messages: [] bankprodukte: [] relations: [] sync: false links: self: $ref: '#/components/links/self' delete_bankzugang: $ref: '#/components/links/delete_bankzugang' get_issues: $ref: '#/components/links/get_issues' get_challenge_pdf: $ref: '#/components/links/get_challenge_pdf' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' redirect_url: $ref: '#/components/links/redirect_url' refresh_bankzugang: $ref: '#/components/links/refresh_bankzugang' '504': description: The started request could not be answered in the given time deprecated: false delete: tags: - Customer Bank Access summary: Delete Bank Access operationId: CustomerBankAccess_deleteBankAccess description: Deletes a specific bank access. parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/customer-ip-address' responses: '200': description: Returns without any further response body. '404': description: >- The bank access with the given access-id was not found / does not exist. deprecated: false /customer/v2/bankzugaenge/{access-id}/issues: get: tags: - Customer Bank Access summary: Get Bank Access Issues operationId: CustomerBankAccess_getIssues description: Retrieves last known issues for a specific bank access for this user. parameters: - $ref: '#/components/parameters/access-id' responses: '200': description: Returns a bank access issues object content: application/json: schema: $ref: '#/components/schemas/BankAccessIssues' example: id: 815251d6-c062-4f61-bec0-182bc14a48fb providerId: 00000000-0000-0000-0000-000000000000 tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN challenge: name: Mock-TAN-Verfahren content: instructions: Enter a TAN that is divisible by 2 decoupled: false redirect: false aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus relations: - rel: set_method href: >- https://banksapi.io/v2/customer/consent/1345340218050910215PSDDE-BAFIN-152070CO4960JJ links: self: $ref: '#/components/links/self' delete_bankzugang: $ref: '#/components/links/delete_bankzugang' get_issues: $ref: '#/components/links/get_issues' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' redirect_url: $ref: '#/components/links/redirect_url' deprecated: false /customer/v2/bankzugaenge/{access-id}/challenge/pdf: get: tags: - Customer Bank Access summary: Get Bank Access Challenge PDF operationId: CustomerBankAccess_getBankAccessChallengePdf description: Retrieves the PDF file from the bank access challenge if available. parameters: - $ref: '#/components/parameters/access-id' responses: '200': description: Returns the PDF file from the bank access challenge if available. content: application/pdf: schema: $ref: >- #/components/schemas/CustomerBankAccessGetBankAccessChallengePdfResponse example: '404': description: The PDF file for the given access-id was not found / does not exist. deprecated: false /customer/v2/bankzugaenge/{access-id}/{product-id}: get: tags: - Customer Bank Access summary: Get Bank Product operationId: CustomerBankAccess_getBankProduct description: Retrieve information for a single bank product. parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' responses: '200': description: Returns data of the bank product. content: application/json: schema: $ref: '#/components/schemas/Product' example: kategorie: GIROKONTO produktbezeichnung: Demo-Girokonto produktId: DE1235233452324553423442A inhaber: Dan Cooper aktualisierungsdatum: '2016-05-23T13:37:00.000Z' saldo: '200000.00' waehrung: USD saldoDatum: '2016-05-23T13:37:00.000Z' kontonummer: '0123456789' iban: DE1235233452324553423442 bic: BICIS133742 blz: '12345678' kreditinstitut: Demo-Bank messages: [] relations: - rel: get_kontoumsaetze href: >- https://test.banksapi.io/customer/v2/bankzugaenge/cba09da4-57fb-4262-b11c-3192b3438265/DE00123456789012345679/kontoumsaetze - rel: initiate_single_transfer href: https://banksapi.io/customer/v2/payment/single-transfer - rel: initiate_bulk_transfer href: https://banksapi.io/customer/v2/payment/bulk-transfer links: self: $ref: '#/components/links/self' get_kontoumsaetze: $ref: '#/components/links/get_kontoumsaetze' initiate_single_transfer: $ref: '#/components/links/initiate_single_transfer' initiate_bulk_transfer: $ref: '#/components/links/initiate_bulk_transfer' initiate_single_transfer_with_saved_credentials: $ref: >- #/components/links/initiate_single_transfer_with_saved_credentials initiate_bulk_transfer_with_saved_credentials: $ref: '#/components/links/initiate_bulk_transfer_with_saved_credentials' get_depotpositionen: $ref: '#/components/links/get_depotpositionen' get_kontoumsaetze_categories: $ref: '#/components/links/get_kontoumsaetze_categories' get_kontoumsaetze_business_partners: $ref: '#/components/links/get_kontoumsaetze_business_partners' get_kontoumsaetze_periods: $ref: '#/components/links/get_kontoumsaetze_periods' get_kontoumsaetze_insurance_types: $ref: '#/components/links/get_kontoumsaetze_insurance_types' get_kontoumsaetze_freelancer_categories: $ref: '#/components/links/get_kontoumsaetze_freelancer_categories' '504': description: The started request could not be answered in the given time deprecated: false /customer/v2/bankzugaenge/{access-id}/{product-id}/kontoumsaetze: get: tags: - Customer Bank Access summary: Get Transactions operationId: CustomerBankAccess_getTransactions description: >- Retrieves all transactions for a specific product of a specific access of this user. parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' - description: >- Only return transactions with a booking date after this Date/Time (ISO 8601 formatted timestamp); may be used with `to` to specify a time window name: from in: query required: false schema: type: string format: date-time example: '2022-02-20T00:00:00.000Z' - description: >- Only return transactions with a booking date before this Date/Time (ISO 8601 formatted timestamp); may be used with `from` to specify a time window name: to in: query required: false schema: type: string format: date-time example: '2022-03-20T00:00:00.000Z' - description: >- The resulting transactions will each contain Categorization objects of the corresponding tag type name: tag in: query required: false schema: enum: - categories - business-partners - periods - insurance-types - freelancer-categories - custom-categories type: string - description: >- Filter to apply to result set. Filter expression must be URL-encoded. Filter expression must be in the form ``. name: filter in: query schema: description: >- URL-encoded filter expression in the form type: string example: identifier.batchId%3Df257c0de-c5f0-4ffd-b942-94b1e631babb responses: '200': description: Returns an array of transactions. content: application/json: schema: $ref: '#/components/schemas/CustomerBankAccessGetTransactionsResponse' example: - betrag: -70 verwendungszweck: EC 68096654 140215204106OC3 Ref. 5CC15048A1824480/89280 buchungsdatum: '2016-11-17T00:00:00.000Z' wertstellungsdatum: '2016-11-15T00:00:00.000Z' gegenkontoInhaber: La Sopia GmbH München gegenkontoIban: DE00123456789012345679 gegenkontoBic: XXX12345678 primanotaNummer: '421337' post: tags: - Customer Bank Access Builder summary: Push transactions for the given product operationId: CustomerBankAccessBuilder_pushTransactions description: >- Pushes transactions for the given product identified by an access and a product ID parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' requestBody: description: List of transactions for this product content: application/json: schema: $ref: >- #/components/schemas/CustomerBankAccessBuilderPushTransactionsRequest example: - betrag: -70 verwendungszweck: EC 68096654 140215204106OC3 Ref. 5CC15048A1824480/89280 buchungsdatum: '2016-11-17T00:00:00.000Z' wertstellungsdatum: '2016-11-15T00:00:00.000Z' gegenkontoInhaber: La Sopia GmbH München gegenkontoIban: DE00123456789012345679 gegenkontoBic: XXX12345678 primanotaNummer: '421337' identifier: batchId: eeToqu2V - betrag: -42.23 verwendungszweck: My in-app purchase buchungsdatum: '2022-11-17T00:00:00.000Z' wertstellungsdatum: '2022-11-17T00:00:00.000Z' gegenkontoInhaber: Gaming Now gegenkontoIban: DE80123456789012345777 gegenkontoBic: XXX12345678 identifier: batchId: eeToqu2V required: true responses: '201': description: Created /customer/v2/bankzugaenge/{access-id}/{product-id}/kontoumsaetze/{transaction-id}: put: tags: - Customer Bank Access summary: modify categorisation of transactions operationId: CustomerBankAccess_modifyTransactionCategorization description: >- This method applies corrections to the categorization of transactions. Initial categorization is required before recategorization. Input contains the tag tree item that should be used for recategorization. A valid tag tree item has to be provided. The flag createRule creates a user specific rule that automatically categorizes this counterparty with the provided tag tree item in all future transactions. This is a smart solution to eradicate a recurring recategorization process. The flag changeExisting recategorizes all existing transactions of the same counterparty. The tagTreeItem has to include a tagTree and has to be wrapped in tags: []. The recategorization currently relies on the systemName value of tagTreeItem and tagTree, but as this might change in the future, both systemName and systemId should be included in the payload, all other fields are ignored. To get a full list of tag tree items, use: GET https://banksapi.io/tags/v1/tags/tag_trees/1/tag_tree_items/ parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' - $ref: '#/components/parameters/transaction-id' - description: '' name: changeExisting in: query required: false schema: type: boolean example: true - description: '' name: createRule in: query required: false schema: type: boolean example: true requestBody: content: application/json: schema: $ref: '#/components/schemas/WrappedTags' required: true responses: '200': description: transaction was successfully modified '400': description: error in request body content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' '404': description: transaction was not found deprecated: false /customer/v2/bankzugaenge/{access-id}/{product-id}/depotpositionen: get: tags: - Customer Bank Access summary: Get Portfolio operationId: CustomerBankAccess_getDepotPositions description: >- Retrieves all investments in a specific banking product of type brokerage account (portfolio depot) for this user. parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' responses: '200': description: >- Returns an array of investments, e.g. stocks, bonds and other positions. content: application/json: schema: $ref: >- #/components/schemas/CustomerBankAccessGetDepotPositionsResponse example: - name: Aberdeen Global - Emer. Markets Equity E2 menge: 210.819609 handelseinheit: STUECK isin: LU0498181733 wkn: A1C5UV kurs: 15.4117 kursDatum: '2021-10-15T15:50:20.000Z' waehrung: EUR waehrungskurs: 1 handelsplatz: KAG gesamtwert: 3249.09 deprecated: false /customer/v2/bankzugaenge/{access-id}/consent: post: tags: - Customer Bank Access Consent summary: Start SCA operationId: CustomerBankAccessConsent_startScaRenewal description: Starts the SCA renewal process parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/customer-ip-address' - $ref: '#/components/parameters/callbackUrl' - $ref: '#/components/parameters/queryTanSettings' - description: Indicator if transactions older than 90 days should be fetched. name: maxTransactions in: query required: false schema: $ref: '#/components/schemas/MaxTransactions' requestBody: description: >- Login data for the access. Only needed if access is not being automatically synchronized with the provider (`sync=false`). content: application/json: schema: $ref: '#/components/schemas/CreateBankAccess' example: 815251d6-c062-4f61-bec0-182bc14a48fb: providerId: 00000000-0000-0000-0000-000000000000 credentials: userid: mOd2uKYr+2 ... TWOPCAt5zP pin: Hhnc+aW/eM ... 7F+XRSHasW sync: true selectedBankProducts: - DE00123456789012345679 required: false responses: '201': $ref: '#/components/responses/bankAccessCreated' '451': $ref: '#/components/responses/regprotect' deprecated: false /customer/v2/bankzugaenge/{access-id}/consent/{consent-id}: post: tags: - Customer Bank Access Consent summary: Update Bank Access Consent operationId: CustomerBankAccessConsent_updateScaMethod description: >- Submits a SCA method, medium or authentication data for the current SCA (e.g. when creating a bank access). parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/consent-id' requestBody: $ref: '#/components/requestBodies/SubmitScaData' responses: '200': description: Returns a bank access object content: application/json: schema: $ref: '#/components/schemas/BankAccess' example: status: VOLLSTAENDIG tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' timeout: '2016-12-24T13:37:42.000Z' messages: [] bankprodukte: [] relations: [] sync: false links: set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' deprecated: false get: tags: - Customer Bank Access Consent summary: Poll Bank Access Consent operationId: CustomerBankAccessConsent_pollStatus description: >- Can be used for the decoupled SCA approach to check if the SCA has already been confirmed. parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/consent-id' responses: '200': description: Returns a bank access object content: application/json: schema: $ref: '#/components/schemas/BankAccess' example: status: VOLLSTAENDIG tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' timeout: '2016-12-24T13:37:42.000Z' messages: [] bankprodukte: [] relations: [] sync: false links: set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' deprecated: false /customer/v2/bankzugaenge/{access-id}/consent/{consent-id}/cancel: post: tags: - Customer Bank Access Consent summary: Cancel Bank Access Consent operationId: CustomerBankAccessConsent_cancelScaRedirect description: >- Cancels an SCA redirect and stops the corresponding access synchronization. This request is permitted only for the redirect SCA approach. parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/consent-id' responses: '200': description: Returns a bank access object content: application/json: schema: $ref: '#/components/schemas/BankAccess' example: id: 815251d6-c062-4f61-bec0-182bc14a48fbX providerId: 00000000-0000-0000-0000-000000000000 aktualisierungszeitpunkt: '2022-02-02T22:22:22.000Z' messages: - level: ERROR code: BA3040 message: SCA fehlgeschlagen details: Redirect-SCA wurde abgebrochen - level: INFO code: BA3000 message: SCA notwendig tanMedien: [] sicherheitsverfahren: [] relations: - rel: self href: >- https://banksapi.io/customer/v2/bankzugaenge/815251d6-c062-4f61-bec0-182bc14a48fb - rel: delete_bankzugang href: >- https://banksapi.io/customer/v2/bankzugaenge/815251d6-c062-4f61-bec0-182bc14a48fb - rel: get_issues href: >- https://banksapi.io/customer/v2/bankzugaenge/815251d6-c062-4f61-bec0-182bc14a48fb/issues - rel: start_sca href: >- https://banksapi.io/customer/v2/bankzugaenge/815251d6-c062-4f61-bec0-182bc14a48fb/consent status: VOLLSTAENDIG bankprodukte: [] sync: false deprecated: false /customer/v2/bankzugaenge/{access-id}/{product-id}/payment/single-transfer: post: tags: - Customer Bank Access Payment summary: Initiate a single transfer operationId: CustomerBankAccessPayment_initiateSingleTransfer description: >- Initiates a payment for the given bank access, without providing access credentials parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' - $ref: '#/components/parameters/customer-ip-address' - $ref: '#/components/parameters/callbackUrl' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: >- #/components/schemas/CustomerBankAccessPaymentInitiateSingleTransferRequest example: transferDetails: recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 1337.42 endToEndId: be7649876d5f439886fa816993ac9f9f required: true responses: '200': $ref: '#/components/responses/singleTransferInitiated' '404': description: Bank Access Credentials could not be found deprecated: false /customer/v2/bankzugaenge/{access-id}/{product-id}/payment/bulk-transfer: post: tags: - Customer Bank Access Payment summary: Initiate a bulk transfer operationId: CustomerBankAccessPayment_initiateBulkTransfer description: >- Initiates a payment for the given bank access, without providing access credentials parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' - $ref: '#/components/parameters/customer-ip-address' - $ref: '#/components/parameters/callbackUrl' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: >- #/components/schemas/CustomerBankAccessPaymentInitiateBulkTransferRequest example: transferDetails: - recipient: UNICEF purpose: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX currency: EUR amount: 150 endToEndId: be7649876d5f439886fa816993ac9f9f - recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 75 endToEndId: be7649876d5f439886fa816993ac9f9f required: true responses: '200': $ref: '#/components/responses/bulkTransferInitiated' '404': description: Bank Access Credentials could not be found deprecated: false /customer/v2/bankzugaenge/{access-id}/{product-id}/payment/single-debit: post: tags: - Customer Bank Access Payment summary: Initiate a single debit operationId: CustomerBankAccessPayment_initiateSingleDebit description: >- Initiates a payment for the given bank access, without providing access credentials parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: '#/components/schemas/SingleDebitDataBankAccess' example: business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' required: true responses: '200': $ref: '#/components/responses/singleDebitInitiated' '404': description: Bank Access Credentials could not be found deprecated: false /customer/v2/bankzugaenge/{access-id}/{product-id}/payment/bulk-debit: post: tags: - Customer Bank Access Payment summary: Initiate a bulk debit operationId: CustomerBankAccessPayment_initiateBulkDebit description: >- Initiates a payment for the given bank access, without providing access credentials parameters: - $ref: '#/components/parameters/access-id' - $ref: '#/components/parameters/product-id' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: '#/components/schemas/BulkDebitDataBankAccess' example: business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: - amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' - amount: 42 currency: EUR purpose: Verwendungszweck 2 endToEndId: '124' debtorName: Maxi Mustermann debtorIban: DE00123456789012345678 debtorAccountNumber: '9012345678' debtorBankCode: '12345678' debtorBic: SSKMDEMMXXX mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' required: true responses: '200': $ref: '#/components/responses/bulkDebitInitiated' '404': description: Bank Access Credentials could not be found deprecated: false /customer/v2/ueberweisung/{provider-id}/{product-id}: post: tags: - Customer Ueberweisung summary: Create Transfer operationId: CustomerUeberweisung_createPayment description: Creates a payment (i.e. initializes a SEPA transfer). parameters: - $ref: '#/components/parameters/provider-id' - $ref: '#/components/parameters/product-id' - $ref: '#/components/parameters/customer-ip-address' - $ref: '#/components/parameters/callbackUrl' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: '#/components/schemas/CreateTransfer' example: credentials: userid: mXlkGe+ukAEs+2iHjc ... 6uyURWRD/MOfGsd8HY= pin: XO2jgZX9V5GvB9rg8 ... CbzjWKilAXdeBXVHC9W1Rv5GfhKpZmw= empfaenger: netzpolitik.org e. V. verwendungszweck: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS waehrung: EUR betrag: 1337.42 ausfuehrungsdatum: '2016-12-24T00:00:00.000Z' sicherheitsverfahrenKodierung: '1' tanMediumName: Mobil required: true responses: '200': description: Returns object with the transfer status content: application/json: schema: $ref: '#/components/schemas/ScaInteraction' example: ueberweisung: empfaenger: netzpolitik.org e. V. verwendungszweck: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS waehrung: EUR betrag: 1337.42 ausfuehrungsdatum: '2016-12-24T00:00:00.000Z' tanMediumName: Mobil tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus relations: - rel: set_method href: >- https://banksapi.io/customer/v2/ueberweisung/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7/consent links: set_method: description: Set SCA method deprecated: true /customer/v2/ueberweisung/bulk/{provider-id}/{product-id}: post: tags: - Customer Ueberweisung summary: Create Bulk Transfer operationId: CustomerUeberweisung_createBulkTransfer description: Creates a bulk payment (i.e. initializes a SEPA transfer). parameters: - $ref: '#/components/parameters/provider-id' - $ref: '#/components/parameters/product-id' - $ref: '#/components/parameters/customer-ip-address' - $ref: '#/components/parameters/callbackUrl' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: '#/components/schemas/CreateBulkTransferLegacy' example: credentials: userid: mXlkGe+u ... /MOfGsd8HY= pin: XO2jgZX ... v5GfhKpZmw= payments: - empfaenger: UNICEF verwendungszweck: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX waehrung: EUR betrag: 150 - empfaenger: netzpolitik.org e. V. verwendungszweck: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS waehrung: EUR betrag: 75 sicherheitsverfahrenKodierung: '1' tanMediumName: Mobil required: true responses: '200': description: Returns object with the transfer status content: application/json: schema: $ref: '#/components/schemas/ScaInteraction' example: payments: - empfaenger: UNICEF verwendungszweck: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX waehrung: EUR betrag: 150 - empfaenger: netzpolitik.org e. V. verwendungszweck: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS waehrung: EUR betrag: 75 ausfuehrungsdatum: '2016-12-24T00:00:00.000Z' tanMediumName: Mobil tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus relations: - rel: set_method href: >- https://banksapi.io/customer/v2/ueberweisung/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7/consent links: set_method: description: Set SCA method deprecated: true /customer/v2/ueberweisung/{provider-id}/{product-id}/{payment-id}: put: tags: - Customer Ueberweisung summary: Submit TAN operationId: CustomerUeberweisung_submitTan description: Submits a TAN for a previously created payment. parameters: - $ref: '#/components/parameters/provider-id' - $ref: '#/components/parameters/product-id' - $ref: '#/components/parameters/payment-id' requestBody: description: Object required to submit a TAN. content: application/json: schema: $ref: '#/components/schemas/CreateTextTan' example: tan: '4103582' required: true responses: '200': description: >- Returns the transfer status. If the TAN was wrong, the hint has changed accordingly and there is still a timeout and the relation `submit_text_tan`. If the TAN was correct then Timeout and the Relations disappear. content: application/json: schema: $ref: '#/components/schemas/Interaction' example: hinweis: Bitte geben Sie die SMS-TAN ein timeout: '2016-12-24T20:00:00.000Z' relations: - rel: submit_text_tan href: >- https://banksapi.io/customer/v2/ueberweisung/DE1235233452324553423442/9b90127c-9b85-11e6-82d8-480fcfb9550f links: submit_text_tan: description: Submit TAN deprecated: true /customer/v2/ueberweisung/bulk/{provider-id}/{product-id}/{payment-id}: put: tags: - Customer Ueberweisung summary: Submit TAN (Bulk) operationId: CustomerUeberweisung_submitTanBulk description: >- Submits a TAN for a previously created bulk payment. Confer [Submit TAN](https://docs.banksapi.de) for details. parameters: - $ref: '#/components/parameters/provider-id' - $ref: '#/components/parameters/product-id' - $ref: '#/components/parameters/payment-id' responses: '200': description: >- Returns the transfer status. If the TAN was wrong, the hint has changed accordingly and there is still a timeout and the relation `submit_text_tan`. If the TAN was correct then Timeout and the Relations disappear. content: application/json: schema: $ref: '#/components/schemas/Interaction' deprecated: true /customer/v2/payment/single-transfer: post: tags: - Customer Payment summary: Initiate Single Transfer operationId: CustomerPayment_initiateSingleTransfer description: Initiates a single transfer (e.g. a SEPA transfer). parameters: - $ref: '#/components/parameters/customer-ip-address' - $ref: '#/components/parameters/callbackUrl' - $ref: '#/components/parameters/queryTanSettings' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: '#/components/schemas/SingleTransferData' example: provider: ca650b48-3edc-45f4-938d-d21df8cba761 credentials: userid: mXlkGe+ukAEs+2iH ... D/MOfGsd8HY= pin: XO2jgZ ... 5GfhKpZmw= product: DE89370400440532013000 transferDetails: recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 1337.42 endToEndId: be7649876d5f439886fa816993ac9f9f required: true responses: '200': $ref: '#/components/responses/singleTransferInitiated' '451': $ref: '#/components/responses/regprotectPayment' deprecated: false /customer/v2/payment/single-transfer/{payment-id}: get: tags: - Customer Payment summary: Get Single Transfer operationId: CustomerPayment_getStatus description: Get the current status of the single transfer. parameters: - $ref: '#/components/parameters/payment-id' responses: '200': description: Returns the current status of the single transfer. content: application/json: schema: $ref: '#/components/schemas/SingleTransferResult' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/single-transfer/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 - rel: set_method href: >- https://banksapi.io/customer/v2/payment/single-transfer/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7/consent transfer: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 paymentId: 5208b5cb-2f88-4bba-87a5-c5e0356c460c transferDetails: recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 1337.42 endToEndId: be7649876d5f439886fa816993ac9f9f deprecated: false /customer/v2/payment/bulk-transfer: post: tags: - Customer Payment summary: Initiate Bulk Transfer operationId: CustomerPayment_initiateBulkTransfer description: Initiates a bulk transfer (e.g. a SEPA bulk transfer). parameters: - $ref: '#/components/parameters/customer-ip-address' - $ref: '#/components/parameters/callbackUrl' - $ref: '#/components/parameters/queryTanSettings' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: '#/components/schemas/BulkTransferData' example: provider: ca650b48-3edc-45f4-938d-d21df8cba761 credentials: userid: mXlkGe+ukAEs+2iH... D/MOfGsd8HY= pin: XO2jgZ... 5GfhKpZmw= product: DE89370400440532013000 transferDetails: - recipient: UNICEF purpose: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX currency: EUR amount: 150 endToEndId: be7649876d5f439886fa816993ac9f9f - recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 75 endToEndId: be7649876d5f439886fa816993ac9f9f required: true responses: '200': $ref: '#/components/responses/bulkTransferInitiated' '451': $ref: '#/components/responses/regprotectPayment' deprecated: false /customer/v2/payment/bulk-transfer/{payment-id}: get: tags: - Customer Payment summary: Get Bulk Transfer operationId: CustomerPayment_getStatusBulkTransfer description: Get the current status of the bulk transfer. parameters: - $ref: '#/components/parameters/payment-id' responses: '200': description: Returns the current status of the bulk transfer. content: application/json: schema: $ref: '#/components/schemas/BulkTransferResult' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/bulk-transfer/fdc61bcd-d0ee-4999-9c77-eff3ba8db0ce - rel: set_method href: >- https://banksapi.io/customer/v2/payment/bulk-transfer/fdc61bcd-d0ee-4999-9c77-eff3ba8db0ce/consent transfer: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 paymentId: 5208b5cb-2f88-4bba-87a5-c5e0356c460c transferDetails: - recipient: UNICEF purpose: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX currency: EUR amount: 150 endToEndId: be7649876d5f439886fa816993ac9f9f - recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 75 endToEndId: be7649876d5f439886fa816993ac9f9f deprecated: false /customer/v2/payment/single-debit: post: tags: - Customer Payment summary: Initiate Single Debit operationId: CustomerPayment_initiateSingleDebit description: Initiates a single debit (e.g. a SEPA debit). parameters: - $ref: '#/components/parameters/queryTanSettings' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: '#/components/schemas/SingleDebitData' example: provider: ca650b48-3edc-45f4-938d-d21df8cba761 credentials: userid: mXlkGe+ukAEs+2iH ... D/MOfGsd8HY= pin: XO2jgZ ... 5GfhKpZmw= product: DE89370400440532013000 business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' required: true responses: '200': $ref: '#/components/responses/singleDebitInitiated' '451': $ref: '#/components/responses/regprotectPayment' deprecated: false /customer/v2/payment/single-debit/{payment-id}: get: tags: - Customer Payment summary: Get Single Debit operationId: CustomerPayment_getDebitStatus description: Get the current status of the single debit. parameters: - $ref: '#/components/parameters/payment-id' responses: '200': $ref: '#/components/responses/singleDebitInitiated' deprecated: false /customer/v2/payment/bulk-debit: post: tags: - Customer Payment summary: Initiate Bulk Debit operationId: CustomerPayment_initiateBulkDebit description: Initiates a bulk debit (e.g. a SEPA debit). parameters: - $ref: '#/components/parameters/queryTanSettings' requestBody: description: >- The request body object carries the data for a payment. It is expected when creating a payment. content: application/json: schema: $ref: '#/components/schemas/BulkDebitData' example: provider: ca650b48-3edc-45f4-938d-d21df8cba761 credentials: userid: mXlkGe+ukAEs+2iH ... D/MOfGsd8HY= pin: XO2jgZ ... 5GfhKpZmw= product: DE89370400440532013000 business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: - amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' - amount: 42 currency: EUR purpose: Verwendungszweck 2 endToEndId: '124' debtorName: Maxi Mustermann debtorIban: DE00123456789012345678 debtorAccountNumber: '9012345678' debtorBankCode: '12345678' debtorBic: SSKMDEMMXXX mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' required: true responses: '200': $ref: '#/components/responses/bulkDebitInitiated' '451': $ref: '#/components/responses/regprotectPayment' deprecated: false /customer/v2/payment/bulk-debit/{payment-id}: get: tags: - Customer Payment summary: Get Bulk Debit operationId: CustomerPayment_getStatus description: Get the current status of the bulk debit. parameters: - $ref: '#/components/parameters/payment-id' responses: '200': $ref: '#/components/responses/bulkDebitInitiated' deprecated: false /customer/v2/consent/{consent-id}: get: tags: - Customer Consent summary: Get Consent operationId: CustomerConsent_getCurrentStatus description: Get the current status of the consent, without polling the provider parameters: - $ref: '#/components/parameters/consent-id' responses: '200': description: Returns the current status of the consent. content: application/json: schema: $ref: '#/components/schemas/Consent' example: messages: - level: INFO code: BA3020 message: SCA Medium auswählen details: Bitte wählen Sie ein SCA-Medium aus scaMediums: - name: Handy Eins mediaClass: MOBILE relations: - rel: self href: >- https://banksapi.io/customer/v2/consent/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 - rel: set_medium href: >- https://banksapi.io/customer/v2/consent/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 links: self: $ref: '#/components/links/self' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' get_single_transfer: $ref: '#/components/links/get_single_transfer' get_bulk_transfer: $ref: '#/components/links/get_bulk_transfer' get_single_debit: $ref: '#/components/links/get_single_debit' get_bulk_debit: $ref: '#/components/links/get_bulk_debit' deprecated: false post: tags: - Customer Consent summary: Update Consent operationId: CustomerConsent_submitScaData description: Submits a SCA method, medium or authentication data for the current SCA. parameters: - $ref: '#/components/parameters/consent-id' requestBody: $ref: '#/components/requestBodies/SubmitScaData' responses: '200': description: Returns the current status of the consent. content: application/json: schema: $ref: '#/components/schemas/Consent' example: messages: - level: INFO code: BA3020 message: SCA Medium auswählen details: Bitte wählen Sie ein SCA-Medium aus scaMediums: - name: Handy Eins mediaClass: MOBILE relations: - rel: self href: >- https://banksapi.io/customer/v2/consent/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 - rel: set_medium href: >- https://banksapi.io/customer/v2/consent/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 links: self: $ref: '#/components/links/self' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' get_single_transfer: $ref: '#/components/links/get_single_transfer' get_bulk_transfer: $ref: '#/components/links/get_bulk_transfer' get_single_debit: $ref: '#/components/links/get_single_debit' get_bulk_debit: $ref: '#/components/links/get_bulk_debit' deprecated: false /customer/v2/consent/{consent-id}/poll: get: tags: - Customer Consent summary: Poll Consent operationId: CustomerConsent_pollStatus description: >- Can be used for the decoupled SCA approach to check if the SCA has already been confirmed. parameters: - $ref: '#/components/parameters/consent-id' responses: '200': description: Returns the current status of the consent. content: application/json: schema: $ref: '#/components/schemas/Consent' example: messages: - level: INFO code: BA3030 message: SCA Challenge details: Bitte autorisieren Sie den Vorgang challenge: name: Entkoppelte Authentifizierung content: instructions: Bitte führen Sie die entkoppelte Authentifizierung durch. decoupled: true redirect: false relations: - rel: self href: >- https://banksapi.io/customer/v2/consent/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 - rel: authenticate href: >- https://banksapi.io/customer/v2/consent/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 - rel: authenticate_decoupled href: >- https://banksapi.io/customer/v2/consent/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7/poll links: self: $ref: '#/components/links/self' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' get_single_transfer: $ref: '#/components/links/get_single_transfer' get_bulk_transfer: $ref: '#/components/links/get_bulk_transfer' get_single_debit: $ref: '#/components/links/get_single_debit' get_bulk_debit: $ref: '#/components/links/get_bulk_debit' deprecated: false /customer/v2/consent/{consent-id}/cancel: post: tags: - Customer Consent summary: Cancel a Consent operationId: CustomerConsent_cancelScaRedirect description: >- Cancels an SCA redirect and stops the corresponding access synchronization. This request is permitted only for the redirect SCA approach. parameters: - $ref: '#/components/parameters/consent-id' responses: '200': description: Returns the current status of the consent. content: application/json: schema: $ref: '#/components/schemas/Consent' example: messages: - level: ERROR code: BA3040 message: SCA fehlgeschlagen details: Redirect-SCA wurde abgebrochen deprecated: false /customer/v2/regprotect/sessions: delete: tags: - Customer REG/Protect summary: Delete all REG/Protect sessions operationId: CustomerRegProtect_invalidateSessions description: Invalidates all REG/Protect sessions of the authenticated user. responses: '200': description: The HTTP status 200 returns without any further response body. deprecated: false /customer/v2/bankzugaenge/{access-id}/selectedbankproducts: put: tags: - Customer REG/Protect summary: Change bank product selection operationId: CustomerRegProtect_changeBankProductSelection description: Change the selected products of the given bank access parameters: - $ref: '#/components/parameters/access-id' responses: default: $ref: '#/components/responses/regprotect' deprecated: false /customer/v2/bankzugaenge/builder: put: tags: - Customer Bank Access Builder summary: Create Bank Access Builder operationId: CustomerBankAccessBuilder_createInstance description: Creates a builder instance for a bank access. requestBody: description: >- The body contains information about the bank access to create the builder for. content: application/json: schema: $ref: '#/components/schemas/CreateBankAccessBuilder' example: id: 815251d6-c062-4f61-bec0-182bc14a48fbX providerId: e966438b-83cf-49b7-bdcb-3d0550bfd8b2 bankprodukte: - id: DE89370400440532013000 bezeichnung: Tagesgeldkonto kategorie: TAGESGELDKONTO saldo: 27365.56 saldoDatum: '2021-10-15T00:00:00.000Z' waehrung: EUR kontonummer: '32013000' iban: DE89370400440532013000 bic: XXX12345678 blz: '12345678' kreditinstitut: Fnord Bank GmbH inhaber: Jane and John Doe - id: DE00123456789012345679X saldo: 42 iban: DE00123456789012345679 inhaber: Jane Doe required: true responses: '201': $ref: '#/components/responses/bankAccessCreated' components: parameters: access-id: description: ID of the bank access name: access-id in: path required: true schema: type: string format: uuid example: d23710a9-8e4b-4595-b01c-dad9499c9fdb product-id: description: ID of a banking product name: product-id in: path required: true schema: type: string example: DE00123456789012345678 transaction-id: description: ID of a transaction name: transaction-id in: path required: true schema: type: string format: uuid example: 6f8b9367-22a9-4026-bf8e-1944d435b408 provider-id: description: ID of a provider name: provider-id in: path required: true schema: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 tenant-name: description: >- Tenant name plays a role in using the API. The tenant name is a URL component in the management API. name: tenant-name in: path required: true schema: type: string example: demo user-id: description: User reference of the user name: user-id in: path required: true schema: type: string example: 1c5b33f6-9c4d-11e6-ba80-480fcfb9550f consent-id: description: ID of the consent name: consent-id in: path required: true schema: type: string format: uuid example: 3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 payment-id: description: ID of the payment name: payment-id in: path required: true schema: type: string format: uuid example: d308a7ae-b762-4a20-8996-7fa22aed6b73 bearer-user-token-authorization: description: The **Authorization** header contains the bearer token. name: Authorization in: header required: true schema: type: string example: Bearer 596cc7a4-f971-4906-bb5f-ecad8af2ba9a customer-ip-address: description: The IP address of the customer. Must be a public IP address (IPv4, IPv6) name: Customer-IP-Address in: header required: true schema: type: string example: 154.25.45.133 callbackUrl: description: A callback URL. name: callbackUrl in: query required: true schema: type: string format: url example: https://demo-tenant.com/callback?state=123 queryTanSettings: description: Flag to ignore saved TAN-settings and query them. name: queryTanSettings in: query required: false schema: type: boolean example: true responses: regprotect: description: >- This response is for REG/Protect tenants. It contains a link to the REG/Protect application in the HTTP header Location headers: Location: description: >- Link to the REG/Protect application. Append a callbackUrl query-parameter to the URL schema: type: string example: >- https://banksapi.io/customer/v2/webform?session=e8c22f9e-fb70-4728-a558-793cef314276&useCase=EXAMPLE_CASE regprotectPayment: description: >- This response is for REG/Protect tenants. It contains a link to the REG/Protect application in the HTTP header Location headers: Location: description: >- Link to the REG/Protect application. Append a callbackUrl query-parameter to the URL schema: type: string example: >- https://banksapi.io/customer/v2/webform?session=e8c22f9e-fb70-4728-a558-793cef314276&useCase=EXAMPLE_CASE links: self: $ref: '#/components/links/self' get_webform: $ref: '#/components/links/get_webform' bankAccessCreated: description: >- HTTP status 201 (Created) is returned together with the HTTP header Location. Under the URL specified in the header, the added bank accesses can be queried analogously by means of an HTTP GET call. headers: Location: description: URL to get the created bank access using GET method schema: type: string example: >- https://banksapi.io/customer/v2/bankzugaenge/c77604d5-2f7c-456a-813f-c7accfc50ef5 singleTransferInitiated: description: Returns object with the transfer status content: application/json: schema: $ref: '#/components/schemas/SingleTransferResult' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/single-transfer/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 - rel: set_method href: >- https://banksapi.io/customer/v2/consent/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 transfer: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 paymentId: 5208b5cb-2f88-4bba-87a5-c5e0356c460c transferDetails: recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 1337.42 endToEndId: be7649876d5f439886fa816993ac9f9f links: self: $ref: '#/components/links/self' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' bulkTransferInitiated: description: Returns object with the transfer status content: application/json: schema: $ref: '#/components/schemas/BulkTransferResult' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/bulk-transfer/fdc61bcd-d0ee-4999-9c77-eff3ba8db0ce - rel: set_method href: >- https://banksapi.io/customer/v2/consent/fdc61bcd-d0ee-4999-9c77-eff3ba8db0ce transfer: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 paymentId: 5208b5cb-2f88-4bba-87a5-c5e0356c460c transferDetails: - recipient: UNICEF purpose: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX currency: EUR amount: 150 endToEndId: be7649876d5f439886fa816993ac9f9f - recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 75 endToEndId: be7649876d5f439886fa816993ac9f9f links: self: $ref: '#/components/links/self' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' singleDebitInitiated: description: Returns object with the debit status content: application/json: schema: $ref: '#/components/schemas/SingleDebitResult' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/single-debit/07788639-abd7-4009-9c9d-2d79079f3f26 - rel: set_method href: >- https://banksapi.io/customer/v2/consent/07788639-abd7-4009-9c9d-2d79079f3f26 debit: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 paymentId: 5208b5cb-2f88-4bba-87a5-c5e0356c460c business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' links: self: $ref: '#/components/links/self' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' bulkDebitInitiated: description: Returns object with the debit status content: application/json: schema: $ref: '#/components/schemas/BulkDebitResult' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/bulk-debit/0b1937c7-82eb-49d4-99cb-6fdca765c450 - rel: set_method href: >- https://banksapi.io/customer/v2/consent/0b1937c7-82eb-49d4-99cb-6fdca765c450 debit: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 paymentId: 5208b5cb-2f88-4bba-87a5-c5e0356c460c business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: - amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' - amount: 42 currency: EUR purpose: Verwendungszweck 2 endToEndId: '124' debtorName: Maxi Mustermann debtorIban: DE00123456789012345678 debtorAccountNumber: '9012345678' debtorBankCode: '12345678' debtorBic: SSKMDEMMXXX mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' links: self: $ref: '#/components/links/self' set_method: $ref: '#/components/links/set_method' set_medium: $ref: '#/components/links/set_medium' authenticate: $ref: '#/components/links/authenticate' authenticate_decoupled: $ref: '#/components/links/authenticate_decoupled' cancel: $ref: '#/components/links/cancel' schemas: AuthenticationInfo: title: AuthenticationInfo description: >- The AuthenticationInfo object provides detailed information about the sign-in process to the provider. With the included data, it is possible to optimize the user experience of the own application in the provider system, which on the one hand reduce the nerve factor for the user but can also minimize their own support expenses due to login problems. required: - fields type: object properties: loginHint: description: >- Note text for the registration process, which applies to the complete registration process type: string fields: description: Array with login parameters type: array items: $ref: '#/components/schemas/Field' example: loginHint: >- Die User-ID setzt sich aus Ihrer 8-stelligen Hauptkontonummer und der 2-stelligen Unterkontonummer zusammen. fields: - fieldkey: userid label: KOMnet-Key secret: false hint: Der DEMOnet-Key ist ist auf Ihrer DEMO-EC-Karte aufgedruckt format: ^.{1,50}$ - fieldkey: pin label: Demo-Passwort secret: true hint: demo1, demo2 oder demo3 format: ^.{1,50}$ Backends: title: Backends required: - scraperName - defaultProcess - accountsAccess - loginAccess - saldoAccess - turnoverAccess - transactionAccess - bausparListAccess - bausparDetailAccess - bausparTurnoverAccess - creditcardsListAccess - creditcardsDetailAccess - creditcardsTurnoverAccess - depotsListAccess - depotsDetailAccess - depotsSecuritiesAccess - tanmethodAccess - maxSyncsPerDayAndUser type: object properties: scraperName: type: string defaultProcess: type: string accountsAccess: type: string loginAccess: type: string saldoAccess: type: string turnoverAccess: type: string transactionAccess: type: string bausparListAccess: type: string bausparDetailAccess: type: string bausparTurnoverAccess: type: string creditcardsListAccess: type: string creditcardsDetailAccess: type: string creditcardsTurnoverAccess: type: string depotsListAccess: type: string depotsDetailAccess: type: string depotsSecuritiesAccess: type: string tanmethodAccess: type: string maxSyncsPerDayAndUser: type: integer format: int32 example: scraperName: mock defaultProcess: SCRAPER accountsAccess: SCRAPER loginAccess: SCRAPER saldoAccess: SCRAPER turnoverAccess: SCRAPER transactionAccess: SCRAPER bausparListAccess: SCRAPER bausparDetailAccess: SCRAPER bausparTurnoverAccess: SCRAPER creditcardsListAccess: SCRAPER creditcardsDetailAccess: SCRAPER creditcardsTurnoverAccess: SCRAPER depotsListAccess: SCRAPER depotsDetailAccess: SCRAPER depotsSecuritiesAccess: SCRAPER tanmethodAccess: SCRAPER maxSyncsPerDayAndUser: 4 Balance: title: Balance type: object properties: saldo: description: Balance/value of bank product type: number example: 200000.13 waehrung: description: >- Currency in which the bank product is valued/managed (Alphabetic Code ISO 4217) type: string example: EUR saldoDatum: description: Balance/value date as reported by the bank/service provider type: string format: YYYY-MM-DD hh:mm:ss example: '2023-02-23T13:37:00.000Z' BankAccess: allOf: - title: Bank Access description: >- The Bank Access contains all information about a single bank access for a specific user. required: - id - providerId - aktualisierungszeitpunkt - relations - status - bankprodukte - sync type: object properties: id: description: The id of the bank access in UUID format. type: string format: uuid providerId: description: >- The id of the provider the bank access belongs to, in UUID format. type: string format: uuid aktualisierungszeitpunkt: description: Date and time of the last query at the bank / service provider type: string format: YYYY-MM-DD hh:mm:ss example: '2016-06-10T17:17:40.000Z' messages: description: >- List of messages that show which steps are required to continue further. type: array items: $ref: '#/components/schemas/Message' tanMedien: description: Lis tof available TAN media. type: array items: $ref: '#/components/schemas/TanMedium' sicherheitsverfahren: description: List of possible security procedures for this account. type: array items: $ref: '#/components/schemas/SecurityProcedure' aktivesSicherheitsverfahren: $ref: '#/components/schemas/SecurityProcedure' challenge: $ref: '#/components/schemas/Challenge' relations: description: List of relations that are available as next steps. type: array items: $ref: '#/components/schemas/Relation' type: description: >- Type of the bank access. This field will not be returned if the value is 'DEFAULT'.

Type list:
  • `DEFAULT`
  • `EBICS`
  • `BUILDER`
  • type: string enum: - DEFAULT - EBICS - BUILDER status: description: >- Retrieval status of the bank account

    Status list:
  • `INTERAKTION` - **Interaction**: User intervention required, e.g. SCA required, see messages and relations
  • `VOLLSTAENDIG` - **Finished**: The data retrieval is completed
  • type: string enum: - INTERAKTION - VOLLSTAENDIG timeout: description: Lifetime of the data in seconds from the time of the update. type: string format: YYYY-MM-DD hh:mm:ss example: '2016-12-24T13:37:42.000Z' bankprodukte: description: The banking products available in the access. type: array items: $ref: '#/components/schemas/Product' example: [] sync: description: >- Whether the bank account is automatically updated in the background or not. type: boolean example: false example: status: VOLLSTAENDIG tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' timeout: '2016-12-24T13:37:42.000Z' bankprodukte: [] sync: false example: status: VOLLSTAENDIG aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' timeout: '2016-12-24T13:37:42.000Z' bankprodukte: [] sync: false tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus relations: - rel: set_method href: >- https://banksapi.io/v2/customer/bankzugaenge/4c45b12f-ae68-4933-86df-ff2578a7a203/consent/0dd14633-1853-4d22-92f9-776429850a6b BankAccessIssues: allOf: - $ref: '#/components/schemas/ScaInteraction' - title: Bank Access Issues additional description: >- The issues endpoint holds the last known issues for a bank access (useful to retrieve the reason for delayed / failed background or manual sync) This method communicates all messages, also errors, that are not displayed in the stable bank access required: - messages - relations type: object properties: aktivesSicherheitsverfahren: $ref: '#/components/schemas/SecurityProcedure' aktualisierungszeitpunkt: description: Time of the last query at the bank / service provider example: '2016-06-10T17:17:40.000Z' id: description: ID of the bank access type: string example: 815251d6-c062-4f61-bec0-182bc14a48fb providerId: description: ID of the provider type: string example: 00000000-0000-0000-0000-000000000000 challenge: $ref: '#/components/schemas/Challenge' example: id: 815251d6-c062-4f61-bec0-182bc14a48fbX providerId: 00000000-0000-0000-0000-000000000000 tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN challenge: name: Mock-TAN-Verfahren content: instructions: Enter a TAN that is divisible by 2 decoupled: false redirect: false aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus relations: - rel: set_method href: >- https://banksapi.io/v2/customer/bankzugaenge/4c45b12f-ae68-4933-86df-ff2578a7a203/consent/0dd14633-1853-4d22-92f9-776429850a6b example: id: 815251d6-c062-4f61-bec0-182bc14a48fbX providerId: 00000000-0000-0000-0000-000000000000 tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN challenge: name: Mock-TAN-Verfahren content: instructions: Enter a TAN that is divisible by 2 decoupled: false redirect: false aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus relations: - rel: set_method href: >- https://banksapi.io/v2/customer/consent/1345340218050910215PSDDE-BAFIN-152070CO4960JJ BankProductStatus: title: BankProductStatus description: >- Retrieval status of the bank product, which always equals the status of the corresponding bank access

    Status list :
  • `INTERAKTION` - **Interaction**: User intervention required, e.g. SCA required, see messages and relations
  • `VOLLSTAENDIG` - **Finished**: The data retrieval is completed
  • type: string enum: - INTERAKTION - VOLLSTAENDIG example: VOLLSTAENDIG BulkDebitData: allOf: - $ref: '#/components/schemas/PaymentBaseInfo' - $ref: '#/components/schemas/DebitBaseInfo' - title: BulkDebitData description: Request data to start a debit required: - debitDetails type: object properties: debitDetails: type: array items: $ref: '#/components/schemas/DebitDetails' example: provider: ca650b48-3edc-45f4-938d-d21df8cba761 credentials: userid: mXlkGe+ukAEs+2iH ... D/MOfGsd8HY= pin: XO2jgZ ... 5GfhKpZmw= product: DE89370400440532013000 business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: - amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' - amount: 42 currency: EUR purpose: Verwendungszweck 2 endToEndId: '124' debtorName: Maxi Mustermann debtorIban: DE00123456789012345678 debtorAccountNumber: '9012345678' debtorBankCode: '12345678' debtorBic: SSKMDEMMXXX mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' BulkDebitDataBankAccess: allOf: - $ref: '#/components/schemas/DebitBaseInfo' - title: BulkDebitDataBankAccess description: Request data to start a bulk debit required: - debitDetails type: object properties: debitDetails: type: array items: $ref: '#/components/schemas/DebitDetails' BulkDebitResult: allOf: - $ref: '#/components/schemas/Consent' - title: BulkDebitResult description: Current status of debit required: - debit type: object properties: debit: allOf: - $ref: '#/components/schemas/DebitBaseInfo' - required: - provider - product - paymentId - ebics - debitDetails type: object properties: provider: type: string format: uuid product: type: string paymentId: description: Unique id generated for each payment. type: string format: uuid ebics: description: Whether this debit was submitted via EBICS or not. type: boolean debitDetails: type: array items: $ref: '#/components/schemas/DebitDetails' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/bulk-debit/0b1937c7-82eb-49d4-99cb-6fdca765c450 - rel: set_method href: >- https://banksapi.io/customer/v2/payment/bulk-debit/0b1937c7-82eb-49d4-99cb-6fdca765c450/consent debit: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: - amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' - amount: 42 currency: EUR purpose: Verwendungszweck 2 endToEndId: '124' debtorName: Maxi Mustermann debtorIban: DE00123456789012345678 debtorAccountNumber: '9012345678' debtorBankCode: '12345678' debtorBic: SSKMDEMMXXX mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' BulkTransferData: allOf: - $ref: '#/components/schemas/PaymentBaseInfo' - title: BulkTransferData description: Request data to start a transfer type: object required: - transferDetails properties: transferDetails: type: array items: $ref: '#/components/schemas/TransferDetails' example: credentials: userid: mXlkGe+ukAEs+2iH... D/MOfGsd8HY= pin: XO2jgZ... 5GfhKpZmw= provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 transferDetails: - recipient: UNICEF purpose: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX currency: EUR amount: 150 endToEndId: be7649876d5f439886fa816993ac9f9f - recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 75 endToEndId: be7649876d5f439886fa816993ac9f9f BulkTransferResult: allOf: - $ref: '#/components/schemas/Consent' - title: BulkTransferResult description: Current status of transfer required: - transfer type: object properties: transfer: required: - provider - product - paymentId - ebics - transferDetails type: object properties: provider: type: string format: uuid product: type: string paymentId: description: Unique id generated for each payment. type: string format: uuid ebics: description: Whether this transfer was submitted via EBICS or not. type: boolean transferDetails: type: array items: $ref: '#/components/schemas/TransferDetails' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/bulk-transfer/fdc61bcd-d0ee-4999-9c77-eff3ba8db0ce - rel: set_method href: >- https://banksapi.io/customer/v2/payment/bulk-transfer/fdc61bcd-d0ee-4999-9c77-eff3ba8db0ce/consent transfer: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 transferDetails: - recipient: UNICEF purpose: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX currency: EUR amount: 150 endToEndId: be7649876d5f439886fa816993ac9f9f - recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 75 endToEndId: be7649876d5f439886fa816993ac9f9f Challenge: title: Challenge description: Contains information about TAN generation required: - name - content type: object properties: name: description: Name of the TAN procedure type: string content: $ref: '#/components/schemas/ChallengeContent' decoupled: description: >- Indicates whether the SCA approach is decoupled, thus not expecting `scaAuthenticationData` within [Submit SCA Data](https://docs.banksapi.de), but just an empty object to confirm the user indicated that he meanwhile confirmed the activity, e.g. through the bank app, independently. type: boolean redirect: description: Indicates whether the SCA approach is redirect. type: boolean example: challenge: name: chipTAN optisch content: instructions: >- Nutzen sie Ihren TAN-Generator und geben sie anschließend Ihre TAN ein. HHD: 11048714955205123456789F14302C303107 HHDUC: 1234567891234567891234567890,01 decoupled: false redirect: false ChallengeContent: title: ChallengeContent description: >- Challenge data needed to perform the authentication with the chosen authentication method type: object properties: instructions: description: Textual description on how to perform authentication type: string example: >- Nutzen sie Ihren TAN-Generator und geben sie anschließend Ihre TAN ein. HHD: description: Textual representation of flicker code when using optical ChipTAN type: string example: 11048714955205123456789F14302C303107 HHDUC: description: Textual representation of code when using FlickerTAN type: string example: 1234567891234567891234567890,01 photo: description: >- Base64-encoded png of the mosaic photo to be displayed to the user when using PhotoTAN type: string example: data:image/png;base64,iVBORw0KGgoAAA... PDF: description: Base64-encoded PDF needed for the challenge type: string example: data:application/pdf;base64,JVBERi0xLjQNCj... example: instructions: >- Nutzen sie Ihren TAN-Generator und geben sie anschließend Ihre TAN ein. HHD: 11048714955205123456789F14302C303107 HHDUC: 1234567891234567891234567890,01 Categorization: title: Categorization description: A Categorization object corresponds to a sales category type: object required: - category - displayName properties: category: description: Unique category name of sales category type: string systemName: description: Unique system name of sales category type: string displayName: description: User friendly name of sales category type: string parentCategory: description: >- If it is a subcategory, this field includes the name of the main category type: string parent: description: >- If it is a subcategory, this field includes the system name of the main category type: string tagScope: description: The scope of the tag type: string tagType: description: The type of the tag type: string tagId: description: Unique id of the tag type: string tagVersion: description: The version of the tag type: string example: category: bills_electricity parentCategory: bills displayName: Strom confidenceLevel: 0.8 ChangeUserDetails: title: ChangeUserDetails description: Parameters to supply when changing user details type: object properties: username: description: The unique username type: string firstname: description: The first name type: string lastname: description: Last name type: string example: username: demouser firstname: demo lastname: user CreateBankAccess: title: CreateBankAccess description: >- A map where the key is the id of the bank access to be created, in UUID format (see example below), and the value is a CreateBankAccessData object. type: object additionalProperties: $ref: '#/components/schemas/CreateBankAccessData' example: d48744c0-132c-4ae4-a909-1ff771f61503: providerId: 00000000-0000-0000-0000-000000000000 credentials: userid: mOd2uKYr+2 ... TWOPCAt5zP pin: Hhnc+aW/eM ... 7F+XRSHasW sync: true selectedBankProducts: - DE00123456789012345679 CreateBankAccessBuilder: title: CreateBankAccessBuilder description: >- An object with all details necessary to create a bank access builder instance. type: object required: - id - providerId - bankprodukte properties: id: description: The ID of the access to create type: string format: uuid example: 7cc37535-6d50-4ec5-82df-31e4fa19c271 providerId: description: >- The ID of the access provider (bank or service provider) according to the provider list type: string format: uuid example: 92858552-1f5f-4264-8c37-67edd4b7af60 bankprodukte: description: The banking products available in the access. type: array items: $ref: '#/components/schemas/SimpleProduct' example: id: 815251d6-c062-4f61-bec0-182bc14a48fbX providerId: 00000000-0000-0000-0000-000000000000 bankprodukte: - id: DE89370400440532013000X status: VOLLSTAENDIG bezeichnung: Tagesgeldkonto kategorie: TAGESGELDKONTO saldo: 27365.56 aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z' saldoDatum: '2021-10-15T00:00:00.000Z' waehrung: EUR kontonummer: '9012345679' iban: DE89370400440532013000 bic: XXX12345678 blz: '12345678' kreditinstitut: Demo Provider inhaber: Fritz Testmüller CreateBankAccessData: title: Create Bank Access Data type: object properties: providerId: description: >- The ID of the access provider (bank or service provider) according to the provider list type: string format: uuid example: 92858552-1f5f-4264-8c37-67edd4b7af60 credentials: $ref: '#/components/schemas/Credentials' sync: description: >- Whether an automatic regular background update is to be performed or not type: boolean example: true selectedBankProducts: description: The set of selected bank products that should be fetched. type: array uniqueItems: true items: type: string ebics: description: Whether this credentials are for EBICS or not. type: boolean example: false hostId: description: Host-ID for EBICS as provided by the bank type: string hostUrl: description: Host-URL for EBICS as provided by the bank type: string example: 815251d6-c062-4f61-bec0-182bc14a48fb: providerId: 00000000-0000-0000-0000-000000000000 credentials: userid: mOd2uKYr+2 ... TWOPCAt5zP pin: Hhnc+aW/eM ... 7F+XRSHasW sync: true selectedBankProducts: - DE00123456789012345679 CreateBulkTransferLegacy: allOf: - title: CreateBulkTransfer description: Request data to start a transfer required: - credentials - payments type: object properties: credentials: $ref: '#/components/schemas/Credentials' sicherheitsverfahrenKodierung: description: Coding of the security procedure to use , see Bank product type: integer format: int32 ausfuehrungsdatum: $ref: '#/components/schemas/DateTime' tanMediumName: description: The TAN medium to be used type: string payments: type: array items: $ref: '#/components/schemas/UeberweisungDetails' example: credentials: userid: mXlkGe+ukA ... MOfGsd8HY= pin: XO2jg ... 5GfhKpZmw= payments: - empfaenger: UNICEF verwendungszweck: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX waehrung: EUR betrag: 150 - empfaenger: netzpolitik.org e. V. verwendungszweck: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS waehrung: EUR betrag: 75 sicherheitsverfahrenKodierung: '1' tanMediumName: Mobil example: payments: - empfaenger: UNICEF verwendungszweck: Spende UNICEF iban: DE57370205000000300000 bic: BFSWDE33XXX waehrung: EUR betrag: 150 - empfaenger: netzpolitik.org e. V. verwendungszweck: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS waehrung: EUR betrag: 75 ausfuehrungsdatum: '2016-12-24T00:00:00.000Z' sicherheitsverfahrenKodierung: '1' tanMediumName: Mobil tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus relations: - rel: set_method href: >- https://banksapi.io/customer/v2/ueberweisung/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7/consent CreateTextTan: title: CreateTextTan required: - tan type: object properties: tan: description: The TAN to confirm the transfers type: string example: tan: '4103582' CreateToken: title: CreateToken description: Parameters to supply upon client token request required: - grant_type type: object properties: grant_type: description: >- Must be one of the following:
    • `password`: Get a user token, which is needed when creating or querying banking accounts.
    • `client_credentials`: Get a client token, which is needed for administrative use cases such as creating users.
    type: string enum: - password - client_credentials username: description: Username of user. **REQUIRED** if 'grant_type' is 'password'! type: string password: description: Password of user. **REQUIRED** if 'grant_type' is 'password'! type: string scope: description: >- Space-separated list of desired scopes. A scope names a class of access rules. It is a string, usually in the form of a (fictitious) URL. The available scopes depend on the scope of services booked. You therefore receive the scope list together with your cooperation agreement. type: string example: grant_type: client_credentials scope: http://banksapi.io/provider/read CreateTransfer: allOf: - $ref: '#/components/schemas/UeberweisungDetails' - title: CreateTransfer description: Request data to start a transfer required: - credentials - empfaenger - verwendungszweck - iban - betrag - bic - waehrung type: object properties: credentials: $ref: '#/components/schemas/Credentials' sicherheitsverfahrenKodierung: description: Coding of the security procedure to use , see Bank product type: integer format: int32 ausfuehrungsdatum: $ref: '#/components/schemas/DateTime' tanMediumName: description: The TAN medium to be used type: string example: credentials: userid: mXlkGe+ukA ... MOfGsd8HY= pin: XO2jg ... 5GfhKpZmw= empfaenger: netzpolitik.org e. V. verwendungszweck: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS waehrung: EUR betrag: 1337.42 ausfuehrungsdatum: '2016-12-24T00:00:00.000Z' sicherheitsverfahrenKodierung: '1' tanMediumName: Mobil CreateUser: title: CreateUser description: Parameters to supply upon user creation required: - username - password type: object properties: username: description: The unique username type: string password: description: >- The password of the user. The password policy is as follows:
  • at least 10 characters
  • at least 2 letters
  • at least 2 special characters (numbers or any other characters like ,.-;:_&%$ etc.)
  • type: string firstname: description: The first name type: string lastname: description: Last name type: string example: username: demouser password: secret firstname: demo lastname: user Credentials: title: Credentials description: >- The Credentials object is a map of encrypted and Base64-encoded access data, corresponding to the provider's authentication fields. The Base64 encoding must not use line wrapping. The encryption method used is described in the chapter Encryption. required: - userid - pin type: object properties: userid: description: >- Encrypted and Base64-encoded username of the user at the bank, e.g. used in his online banking.
    EBICS: The User-ID (Teilnehmer-ID) as provided by the bank must be transmitted. type: string example: cust0815 pin: description: >- Encrypted and Base64-encoded pin / password of the user at the bank, e.g. used in his online banking.
    EBICS: A pin must not be transmitted. type: string example: verySecret partnerid: description: >- Encrypted and Base64-encoded partner id (Kunden-ID) only required for EBICS. type: string example: PID0001 corporateid: description: >- Encrypted and Base64-encoded corporate id required by some banks for business accounts. type: string example: 123456 example: userid: mOd2uKYr+2 ... TWOPCAt5zP pin: Hhnc+aW/eM ... 7F+XRSHasW Customer: title: Customer description: >- The Customer object maps the data of the unique user on the interface. It also forms the entry point into the deeper functions of the interface. type: object properties: messages: type: array items: $ref: '#/components/schemas/Message' bankzugaenge: type: object relations: type: array items: $ref: '#/components/schemas/Relation' example: bankzugaenge: 4000fda7-18af-463f-b694-bbafe5d23a48: messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus sicherheitsverfahren: - kodierung: 980 name: mTAN hinweis: mTAN - name: SMS_OTP kodierung: '942' hinweis: SMS OTP relations: - rel: start_sca href: >- https://banksapi.io/v2/customer/consent/1345340218050910215PSDDE-BAFIN-152070CO4960JJ relations: - rel: start_sca href: https://banksapi.io/customer/v2 - rel: authenticate href: https://banksapi.io/customer/v2 - rel: set_method href: https://banksapi.io/customer/v2/consent/{consent-id} - rel: set_medium href: https://banksapi.io/customer/v2/consent/{consent-id} - rel: self href: https://banksapi.io/customer/v2 - rel: get_bankzugaenge href: https://banksapi.io/customer/v2/bankzugaenge - rel: add_bankzugaenge href: https://banksapi.io/customer/v2/bankzugaenge - rel: delete_bankzugaenge href: https://banksapi.io/customer/v2/bankzugaenge DateTime: title: DateTime description: >- This object represents a timestamp. Format: `YYYY-MM-DD hh:mm:ss`. Data will be interpreted according to the time zone Europe/Berlin. type: string example: '2019-12-04T13:37:00.000Z' DebitBaseInfo: required: - creditorSchemeIdentification - requestedCollectionDate type: object properties: business: description: >- Indicates whether the debit should be submitted for business or private customers.

    It is recommended to assign this field together with `sequenceType` on the top layer (here) and not in debitDetails. Moreover, it is not allowed to assign these fields on both levels at the same time. type: boolean sequenceType: $ref: '#/components/schemas/DebitSequenceType' creditorSchemeIdentification: description: The scheme identification of the creditor. type: string requestedCollectionDate: description: Time requested collection date of the debit. type: string format: YYYY-MM-DD DebitDetails: allOf: - title: DebitDetails description: DebitDetails are used in InitiateSingleDebit and InitiateBulkDebit required: - amount - currency - purpose - endToEndId - debtorName - debtorIban - mandateIdentification - mandateDateOfSignature type: object properties: amount: description: Debit amount type: number format: double currency: description: Currency of the debit type: string purpose: description: Purpose of the debit. type: string endToEndId: description: End to End Identification of the debit. type: string debtorName: description: Name of the debtor. type: string debtorIban: description: IBAN of the debtor. type: string debtorAccountNumber: description: Account number of the debtor. type: string debtorBankCode: description: Bank code of the debtor. type: string debtorBic: description: BIC of the debtor. type: string mandateIdentification: description: Identification of the mandate. type: string mandateDateOfSignature: description: The signature date of the mandate. type: string format: YYYY-MM-DD business: description: >- Indicates whether the debit should be submitted for business or private customers.

    The mixing of true / false is not allowed in the same request.

    It is recommended to assign this field together with `sequenceType` on the top layer and not in debitDetails. Moreover, it is not allowed to assign these fields on both levels at the same time. type: boolean sequenceType: $ref: '#/components/schemas/DebitSequenceType' DebitSequenceType: title: DebitSequenceType description: >- Sequence type of the debit.

    It is recommended to assign this field together with `business` on the top layer and not in debitDetails. Moreover, it is not allowed to assign these fields on both levels at the same time.

    Sequence types:
  • `FRST` - first debit
  • `RCUR` - recurrent debit
  • `FNAL` - final debit
  • `OOFF` - one-off debit
  • enum: - FRST - RCUR - FNAL - OOFF type: string EntitySchema: properties: displayName: description: Display name of the entity example: TRANSACTION type: string entityClass: description: Class of the entity, such as TRANSACTION or USER example: TRANSACTION type: string id: description: Transaction UUID or USER UUID. example: 156ca508-c0e2-52c5-3202-8de20e7ed12b type: string userId: description: UUID of the USER. Same as id field for USER entities. example: 156ca508-c0e2-52c5-3202-8de20e7ed12b type: string required: - displayName - entityClass - id type: object Field: title: Field required: - fieldkey - label - secret - format type: object properties: fieldkey: description: Name of the parameter in the **Credentials** object type: string label: description: Name of the field for the ad type: string secret: description: >- Specifies whether the field contains a secret, for example, should be hidden or only optionally stored type: boolean hint: description: An explanation text for display next to the field type: string format: description: >- A regular expression (regex) pattern specifying the format for the input field type: string example: fieldkey: pin label: Demo-Passwort secret: true hint: demo1, demo2 oder demo3 format: ^.{1,50}$ Interaction: title: Interaction description: Result of a request if further interaction is required required: - relations - messages type: object properties: messages: description: Messages for TAN input or error texts for transfer type: array items: $ref: '#/components/schemas/Message' relations: description: Relations for follow-up actions type: array items: $ref: '#/components/schemas/Relation' timeout: description: Time to wait for follow-up actions type: string format: date challenge: $ref: '#/components/schemas/Challenge' example: messages: - code: BA1110 level: INFO message: TAN-Eingabe nötig details: Bitte geben Sie die TAN ein timeout: '2017-08-31T16:08:55.000Z' relations: - rel: submit_text_tan href: >- https://banksapi.io/customer/v2/ueberweisung/00000000-0000-0000-0000-000000000000/DE00123456789012345679/c612b2f3-f797-4f66-bec4-2064812c8736 challenge: name: chipTAN optisch content: HHD: 11048714955205123456789F14302C303107 HHDUC: 1234567891234567891234567890,01 decoupled: false redirect: false Investment: title: Investment description: >- A securities account item corresponds to a security position of a securities account. type: object properties: name: description: >- Name of the deposit position, usually the name of the financial instrument type: string menge: description: Amount with decimal places type: number handelseinheit: description: Trade item, STUECK or NOMINAL type: string enum: - STUECK - NOMINAL isin: description: ISIN of the financial instrument type: string wkn: description: WKN of the financial instrument type: string kurs: description: Price in trading currency type: number kursDatum: description: The quote date type: string format: YYYY-MM-DD hh:mm:ss waehrung: description: Trading currency (Alphabetic Code ISO 4217) type: string waehrungskurs: description: Conversion rate from EUR to the trading currency type: number handelsplatz: description: Trading place of the price determination type: string gesamtwert: description: >- Total value of the stock in the currency given in 'waehrung' as at the end of the financial statements type: number example: name: GENERAL ELECTRIC CO menge: 167 handelseinheit: STUECK isin: US3696041033 wkn: '851144' kurs: 24.32 kursDatum: '2021-10-15T15:31:20.000Z' waehrung: USD waehrungskurs: 1.18 handelsplatz: Xetra gesamtwert: 3441.9 IsoDateTime: title: IsoDateTime description: >- This object represents an ISO timestamp. Format: ISO 8601 in the form `YYYY-MM-DDThh:mm:ss`. Data will be interpreted according to the time zone Europe/Berlin. type: string example: '2019-12-04T13:37:00.000Z' Job: title: Job required: - jobType - engine type: object properties: jobType: type: string engine: type: string prio: type: integer format: int32 example: jobType: SAMMLER engine: SCRAPER prio: 1 ListOfBankAccesses: title: ListOfBankAccesses description: >- Collection of bank accesses as an object. For each bank access, the object will contain properties where the name is the *id* of the bank access and the value is the bank access data. type: object additionalProperties: $ref: '#/components/schemas/BankAccess' example: 0b7f4783-4c93-4820-8e73-354a0f1c469e: id: 0b7f4783-4c93-4820-8e73-354a0f1c469eX providerId: 00000000-0000-0000-0000-000000000000 aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z' tanMedien: - name: Mobil medienklasse: MOBIL gueltigVon: '2021-10-15T09:13:44.000Z' gueltigBis: '2021-10-15T09:13:44.000Z' sicherheitsverfahren: - kodierung: 1 name: mockTAN hinweis: Gib eine durch 2 teilbare Zahl ein - kodierung: 999 name: iTAN hinweis: Gib die TAN "12" an. aktivesSicherheitsverfahren: kodierung: 999 name: iTAN hinweis: Gib die TAN "12" an. relations: - rel: self href: >- https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e - rel: delete_bankzugang href: >- https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e status: VOLLSTAENDIG bankprodukte: - id: DE00123456789012345679X status: VOLLSTAENDIG bezeichnung: Tagesgeldkonto kategorie: TAGESGELDKONTO saldo: 27365.56 aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z' saldoDatum: '2021-10-15T00:00:00.000Z' waehrung: EUR kontonummer: '9012345679' iban: DE00123456789012345679 bic: XXX12345678 blz: '12345678' kreditinstitut: Demo Provider inhaber: Fritz Testmüller transferSupport: true relations: - rel: get_kontoumsaetze href: >- https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e/DE00123456789012345679/kontoumsaetze - rel: initiate_single_transfer href: https://banksapi.io/customer/v2/payment/single-transfer - rel: initiate_bulk_transfer href: https://banksapi.io/customer/v2/payment/bulk-transfer messages: [] verfuegungsrahmen: 27365.56 verfuegterBetrag: 0 sync: true 4000fda7-18af-463f-b694-bbafe5d23a48: status: VOLLSTAENDIG tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL sicherheitsverfahren: - kodierung: 2 name: mTAN hinweis: mTAN - kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktivesSicherheitsverfahren: kodierung: 1 name: Mock-TAN hinweis: Mock-TAN aktualisierungszeitpunkt: '2016-06-10T17:17:40.000Z' timeout: '2016-12-24T13:37:42.000Z' messages: [] bankprodukte: [] relations: [] sync: false MaxTransactions: title: MaxTransactions description: >- Indicator if transactions older than 90 days should be fetched

    MaxTransactions:
  • `none` - default value
  • `all` - all accounts
  • `paymentAccounts` - only payment accounts
  • enum: - none - all - paymentAccounts type: string MediaClass: title: MediaClass description: >- Media Classes:
  • `LISTE` - Paper-TAN list
  • `GENERATOR` - TAN generator
  • `MOBILE` - mobile phone
  • `SECODER` - TAN matrix generator
  • `PUSHTAN` - Push message
  • `ALL` - All classes
  • `PROPRIETARY` - Proprietary media
  • type: string enum: - LISTE - GENERATOR - MOBILE - SECODER - PUSHTAN - ALL - PROPRIETARY example: MOBILE Message: title: Message description: Messages transport both errors and analysis events. required: - level - code - message type: object properties: level: description: Level of the message, INFO or ERROR type: string enum: - INFO - ERROR code: $ref: '#/components/schemas/MessageCode' message: description: >- **Error** text for display by the end customer according to **errors and messages** type: string details: description: >- Further information on the display at the end customer, which can change from message to message. type: string example: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus MessageCode: title: MessageCode description: >- Code of the message

    Message Codes:
  • `BA999` - Internal error (ERROR)
  • `BA1000` - Maintenance work provider (ERROR)
  • `BA1001` - Provider no longer active (ERROR)
  • `BA1010` - Access blocked (ERROR)
  • `BA1011` - Access data incorrect (ERROR)
  • `BA1012` - Access data incomplete (ERROR)
  • `BA1013` - Account not activated (ERROR)
  • `BA1014` - Too many unsuccessful logins (ERROR)
  • `BA1020` - Account has improper permissions (ERROR)
  • `BA1051` - Bank access unavailable (ERROR)
  • `BA1052` - Bank access not fully available (ERROR)
  • `BA1053` - Access exceeded (ERROR)
  • `BA1060` - Product could not be updated (ERROR)
  • `BA1062` - Transactions could not be updated (ERROR)
  • `BA1063` - Depot positions could not be updated (ERROR)
  • `BA1064` - Message from bank (ERROR)
  • `BA1100` - Transfer data invalid (ERROR)
  • `BA1101` - Invalid TAN procedure (ERROR)
  • `BA1102` - Invalid TAN medium (ERROR)
  • `BA1103` - TAN invalid (ERROR)
  • `BA1104` - Bank transfer not possible (ERROR)
  • `BA1110` - TAN input required (INFO)
  • `BA1111` - The transfer has been completed successfully (INFO)
  • `BA1112` - The transfer has been submitted successfully (INFO)
  • `BA1200` - Debit data invalid (ERROR)
  • `BA1204` - Debit not supported (ERROR)
  • `BA1212` - The debit has been submitted successfully (INFO)
  • `BA2002` - There are notifications from your bank (INFO)
  • `BA2003` - Product type not supported (INFO)
  • `BA2004` - Bank access not activated yet (INFO)
  • `BA2021` - Missing permission (INFO)
  • `BA2062` - Transactions not available (INFO)
  • `BA3000` - SCA required (INFO)
  • `BA3005` - SCA redirect required (INFO)
  • `BA3010` - Select SCA method (INFO)
  • `BA3020` - Select SCA medium (INFO)
  • `BA3030` - SCA Challenge (INFO)
  • `BA3040` - SCA failed (ERROR)
  • `BA3060` - No supported SCA method found (ERROR)
  • type: string enum: - BA999 - BA1000 - BA1001 - BA1010 - BA1011 - BA1012 - BA1013 - BA1014 - BA1020 - BA1051 - BA1052 - BA1053 - BA1060 - BA1062 - BA1063 - BA1064 - BA1100 - BA1101 - BA1102 - BA1103 - BA1104 - BA1110 - BA1111 - BA1112 - BA1200 - BA1204 - BA1212 - BA2002 - BA2003 - BA2004 - BA2021 - BA2062 - BA3000 - BA3005 - BA3010 - BA3020 - BA3030 - BA3040 - BA3060 example: BA999 MessageLevel: title: MessageLevel description: Level of the message, INFO or ERROR enum: - INFO - ERROR type: string example: ERROR PaymentBaseInfo: required: - provider - credentials - product type: object properties: provider: description: Provider to initiate the payment from type: string format: uuid credentials: $ref: '#/components/schemas/Credentials' product: description: Product to initiate the payment from type: string Consent: type: object properties: messages: description: Messages transport both errors and analysis events. type: array items: $ref: '#/components/schemas/Message' scaMethods: description: List of possible sca methods for this account. type: array items: $ref: '#/components/schemas/SecurityProcedureEn' scaMediums: description: List of possible sca mediums for this account. type: array items: $ref: '#/components/schemas/TanMediumEn' challenge: $ref: '#/components/schemas/Challenge' relations: description: The relations available for the payment type: array items: $ref: '#/components/schemas/Relation' Product: allOf: - $ref: '#/components/schemas/SimpleProduct' - title: Product description: >- Banking product with all available fields. A simpler version of this object is required: - id - kategorie - aktualisierungszeitpunkt - kontonummer - relations type: object properties: status: description: Retrieval status for product data type: string example: VOLLSTAENDIG aktualisierungszeitpunkt: description: Time of the last product update at the bank/service provider type: string format: YYYY-MM-DD hh:mm:ss example: '2016-05-23T13:37:00.000Z' transferSupport: description: >- Indicates if transfers are supported for this bank product or not. type: boolean bulkTransferSupport: description: >- Indicates if bulk transfers are supported for this bank product or not. type: boolean relations: description: List of relations that are available as next steps. type: array items: $ref: '#/components/schemas/Relation' messages: description: >- List of messages that show which steps are required to continue further. type: array items: $ref: '#/components/schemas/Message' saldoDatenquelle: description: >- The source of the data for this depots balance. Only for products of type depot. type: string enum: - SWIFTMSG - SONSTIGE ueberziehungslimit: description: >- The overdraft limit for a bank account. Only for products that have an overdraft limit. type: number verfuegungsrahmen: description: >- Contains the available balance (usually overdraft limit + balance) type: number example: 500 verfuegterBetrag: description: >- Contains the available balance (usually overdraft limit + balance) type: number example: 200 vertragsnummer: description: The contract number for home savings contracts. type: string rating: description: '' type: number vertragssumme: description: The contract amount for home savings contracts. type: number vertragstyp: description: The type of home savings contract. type: string sparzustand: description: >- Shows if the home savings contract is currently in saving state (true) or not (false) type: boolean vertragsstatus: description: The current state of a home savings contract. type: string sparzinssatz: description: The savings rate of a home savings contract. type: number schuldzinssatz: description: The debt interest rate of a home savings contract. type: number vertragsDatum: description: The date of a home savings contract. type: string format: YYYY-MM-DD hh:mm:ss example: id: DE00123456789012345679X status: VOLLSTAENDIG bezeichnung: Tagesgeldkonto kategorie: TAGESGELDKONTO saldo: 27365.56 aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z' saldoDatum: '2021-10-15T00:00:00.000Z' waehrung: EUR kontonummer: '9012345679' iban: DE00123456789012345679 bic: XXX12345678 blz: '12345678' kreditinstitut: Demo Provider inhaber: Fritz Testmüller transferSupport: true relations: - rel: get_kontoumsaetze href: >- https://banksapi.io/customer/v2/bankzugaenge/0b7f4783-4c93-4820-8e73-354a0f1c469e/DE00123456789012345679/kontoumsaetze - rel: initiate_single_transfer href: https://banksapi.io/customer/v2/payment/single-transfer - rel: initiate_bulk_transfer href: https://banksapi.io/customer/v2/payment/bulk-transfer messages: [] verfuegungsrahmen: 27365.56 verfuegterBetrag: 0 ProductCategories: title: ProductCategories description: A list of product categories type: array items: $ref: '#/components/schemas/ProductCategory' example: - GIROKONTO - TAGESGELDKONTO ProductCategory: title: ProductCategory description: >- Categories:
  • `GIROKONTO` - **Checking account**: Account for payment transactions, as well as for the settlement / processing of eg deposit-related bookings, fees, interest, etc.
  • `SPARKONTO` - **Savings account**: Interest-bearing account with an unlimited term and fixed period of notice, as a rule an immediate withdrawal is limited to a maximum value
  • `FESTGELDKONTO` - **Fixed deposit account**: Interest-bearing account with a contractually agreed term
  • `KREDITKONTO` - **Credit account**: Account for managing the loan balance
  • `TAGESGELDKONTO` - **Overnight money account**: Interest-based account for an investment with daily availability
  • `BAUSPARVERTRAG` - **Building loan account**: Savings and possibly loan account for a home savings contract
  • `SONSTIGESKONTO` - Account that can not be assigned by the provider or our product heuristic
  • `KREDITKARTE` - **Credit card**: Payment card with credit line, billing takes place via an agreed current account / clearing account
  • `KREDITKARTENKONTO` - **Credit card acount**:
  • `SONSTIGEKARTE` - **Other card**: Payment card that can not be assigned by the provider or our product heuristic
  • `DEPOT` - **Brokerage account**
  • `SONSTIGESPRODUKT` - Bank product that can not be assigned by the provider or our product heuristic type: string enum: - GIROKONTO - SPARKONTO - FESTGELDKONTO - KREDITKONTO - TAGESGELDKONTO - BAUSPARVERTRAG - SONSTIGESKONTO - KREDITKARTE - KREDITKARTENKONTO - SONSTIGEKARTE - DEPOT - SONSTIGESPRODUKT example: GIROKONTO Provider: title: Provider description: Provider information required: - id - name - consumerRelevant - relations - capabilities - authenticationInfo type: object properties: id: description: Unique key for this provider in **BANKSapi Banks/Connect** type: string name: description: Name for the provider, not unique type: string consumerRelevant: description: >- Whether this provider should be displayed to the customer for the provider selection or not type: boolean group: description: >- Grouping term for providers. If several providers have the same group the same logo could be displayed, e.g. type: string blz: description: >- The bank code of the bank was the primary key for banks in Germany before SEPA type: string bic: description: The BIC (Business Identifier Code) of the bank type: string relations: description: Relations indicate which operation the provider resource supports type: array items: $ref: '#/components/schemas/Relation' capabilities: description: >- Shows which technical objects with the Provider on the BANKS/Connect Customer API are available type: array items: type: string channels: description: >- Shows which product categories are queried by BANKSapi to the bank through which channel. Items in the same array are queried through the same channel, e.g. FinTS. If you are requesting products that are listed in the same array (going through the same channel), you might save on a number of SCA processes, because there will be at least one SCA per channel at least every 180 days. type: array items: $ref: '#/components/schemas/ProductCategories' authenticationInfo: $ref: '#/components/schemas/AuthenticationInfo' example: id: 00000000-0000-0000-0000-000000000000X name: Demo Provider group: demo blz: '12345678' bic: DEMO1234 relations: - rel: self href: >- https://banksapi.io/providers/v2/00000000-0000-0000-0000-000000000000 - rel: logo href: https://banksapi.io/providers/v2/demo.svg capabilities: - KONTEN - KARTEN - DEPOTS channels: - - GIROKONTO - - KREDITKARTE - TAGESGELDKONTO authenticationInfo: loginHint: >- Der Demo Provider bietet drei Zugänge demo1/demo1, demo2/demo2 und demo3/demo3 fields: - fieldkey: userid label: Demo-User secret: false hint: demo1, demo2 oder demo3 format: ^.{1,50}$ - fieldkey: pin label: Demo-Passwort secret: true hint: demo1, demo2 oder demo3 format: ^.{1,50}$ ProviderCoreData: title: ProviderCoreData description: Provider core information required: - id - name type: object properties: id: description: Unique key for this provider in **BANKSapi Banks/Connect** type: string name: description: Name for the provider, not unique type: string group: description: >- Grouping term for providers. If several providers have the same group the same logo could be displayed, e.g. type: string blz: description: >- The bank code of the bank was the primary key for banks in Germany before SEPA type: string bic: description: The BIC (Business Identifier Code) of the bank type: string logo: description: Returns the path to the provider logo in SVG-format type: string example: - id: 00000000-0000-0000-0000-000000000000X name: Demo Provider group: demo blz: '12345678' bic: DEMO1234 logo: https://banksapi.io/providers/v2/demo.svg ProviderJobStatistics: title: ProviderJobStatistics description: Provider job statistics required: - logo - latestSuccessDate - averageDuration - successRate type: object properties: logo: description: Logo of the provider. type: string latestSuccessDate: description: >- Date of the latest successful data job for providers with the corresponding logo. type: string format: YYYY-MM-DD hh:mm:ss averageDuration: description: >- The average duration of data jobs for providers with the corresponding logo. type: number successRate: description: >- The success rate of data jobs for providers with the corresponding logo. type: number example: - logo: demo latestSuccessDate: '2023-09-20T11:21:02.000Z' averageDuration: 29962 successRate: 1 - logo: sparkasse latestSuccessDate: '2023-09-20T11:28:57.000Z' averageDuration: 54186 successRate: 0.99 ProviderEbicsInfo: title: ProviderEbicsInfo description: Provider EBICS information type: object properties: hostId: description: The EBICS host ID of the bank type: string hostUrl: description: The EBICS host URL of the bank type: string example: hostId: HOSTIDXY hostUrl: https://ebics.bank.com/ebics Relation: title: Relation description: >- A relation corresponds to an application or business transaction that is supported by the enclosing data object. Each application or business transaction has its own documentation, which describes the call as well as the return or the possible alternative answer scenarios in detail. required: - rel - href type: object properties: rel: description: Machine readable string to differentiate the relations type: string example: self href: description: URL where the relation links to type: string example: >- https://banksapi.io:443/providers/v2/00000000-0000-0000-0000-000000000000 example: rel: self href: >- https://banksapi.io:443/providers/v2/00000000-0000-0000-0000-000000000000 RelationSchema: properties: href: description: Link of the relation example: https://banksapi.io/.../tags/tag-trees/1/ type: string rel: description: Name of the relation example: tag_trees type: string required: - href - rel type: object ScaInteraction: title: ScaInteraction description: >- BankAccess and Transfer inherit from this object. It indicates that in some cases, SCA may be needed to interact with the inheriting object. required: - messages - relations type: object properties: messages: description: Messages transport both errors and analysis events. type: array items: $ref: '#/components/schemas/Message' relations: description: The relations available for bank access type: array items: $ref: '#/components/schemas/Relation' tanMedien: description: List of available TAN media in the access type: array items: $ref: '#/components/schemas/TanMedium' example: tanMedien: - gueltigVon: '2016-06-03T17:17:41.000Z' gueltigBis: '2016-06-03T17:17:41.000Z' name: Mobil medienklasse: MOBIL messages: - level: INFO code: BA3010 message: SCA benötigt details: Bitte wählen Sie eine SCA-Methode aus relations: - rel: set_method href: >- https://banksapi.io/v2/customer/consent/1345340218050910215PSDDE-BAFIN-152070CO4960JJ SecurityProcedure: title: SecurityProcedure description: >- The security procedure determines how end users authenticate their transaction(s). type: object properties: kodierung: description: Key to the security procedure type: integer name: description: Human readable name for the security procedure type: string hinweis: description: Human readable reference to the security procedure type: string example: kodierung: 4711 name: mTAN hinweis: Ihre mTAN SecurityProcedureEn: title: SecurityProcedureEn description: >- The security procedure determines how end users authenticate their transaction(s). type: object properties: code: description: Key to the security procedure type: integer name: description: Human readable name for the security procedure type: string hint: description: Human readable reference to the security procedure type: string example: code: 4711 name: mTAN hint: Ihre mTAN SecurityProcedures: title: SecurityProcedures description: >- Das Sicherheitsverfahren bestimmt, wie der Endkunde seine Transaktion(en) freigibt. Am häufigsten sind die TAN-Verfahren wie smsTAN, eTAN, chipTAN, photoTAN, pushTAN etc. im Einsatz. Daneben gibt es noch etliche weitere Verfahren wie bspw. das Biometrie-Verfahren (Fingerprint) oder das RSA-/DES-Verfahren sowie Verfahren mit elektronischer Unterschrift (Sicherheitsdatei). Es ist zu beachten, dass nicht alle Sicherheitsverfahren durch FinTS unterstützt werden. required: - kodierung - name - hinweis type: object properties: kodierung: description: Code of the SCA method type: integer format: int32 example: 980 name: description: Human-readable name of the SCA method type: string example: Mock-TAN hinweis: description: Additional helpful hint that must be displayed to the user type: string example: This is a Mock-TAN, you can enter any value example: kodierung: 980 name: mTAN hinweis: mTAN SimpleProduct: title: Simple Product description: Banking product (e.g. account) with only a subset available product data required: - id - kontonummer type: object properties: id: description: Identifier for the bank product type: string example: DE89370400440532013000 bezeichnung: description: Name of bank product according to bank/service provider type: string kategorie: description: >- Categories:
  • `GIROKONTO` - **Checking account**: Account for payment transactions, as well as for the settlement / processing of eg deposit-related bookings, fees, interest, etc.
  • `SPARKONTO` - **Savings account**: Interest-bearing account with an unlimited term and fixed period of notice, as a rule an immediate withdrawal is limited to a maximum value
  • `FESTGELDKONTO` - **Fixed deposit account**: Interest-bearing account with a contractually agreed term
  • `KREDITKONTO` - **Credit account**: Account for managing the loan balance
  • `TAGESGELDKONTO` - **Overnight money account**: Interest-based account for an investment with daily availability
  • `BAUSPARVERTRAG` - **Building loan account**: Savings and possibly loan account for a home savings contract
  • `SONSTIGESKONTO` - Account that can not be assigned by the provider or our product heuristic
  • `KREDITKARTE` - **Credit card**: Payment card with credit line, billing takes place via an agreed current account / clearing account
  • `SONSTIGEKARTE` - **Other card**: Payment card that can not be assigned by the provider or our product heuristic
  • `DEPOT` - **Brokerage account**
  • `SONSTIGESPRODUKT` - Bank product that can not be assigned by the provider or our product heuristic type: string default: SONSTIGESKONTO enum: - GIROKONTO - SPARKONTO - FESTGELDKONTO - KREDITKONTO - TAGESGELDKONTO - BAUSPARVERTRAG - VERSICHERUNG - SONSTIGESKONTO - AMERICANEXPRESS - MASTERCARD - VISA - DINERSCLUB - SONSTIGEKARTE - DEPOT - KREDITKARTENKONTO saldo: description: Balance/value of bank product (with two decimal places) type: number example: 200000 saldoDatum: description: Balance/value date as reported by the bank/service provider type: string format: YYYY-MM-DD hh:mm:ss example: '2016-05-23T13:37:00.000Z' waehrung: description: >- Currency in which the bank product is valued/managed (Alphabetic Code ISO 4217) type: string example: USD salden: description: >- A map where the key is the currency and the value is a Balance object. This field is only returned for multicurrency accounts. type: object additionalProperties: $ref: '#/components/schemas/Balance' example: EUR: saldo: 20000.13 waehrung: EUR saldoDatum: '2023-08-15T00:00:00.000Z' USD: saldo: 5000.01 waehrung: USD saldoDatum: '2023-08-15T00:00:00.000Z' kontonummer: description: >- The account or credit card number. The credit card number may not be issued completely, but with a star e.g. "3223 ****** 4554" type: string example: '0123456789' iban: description: The IBAN (International Bank Account Number) type: string example: DE89370400440532013000 bic: description: The BIC (Business Identifier Code) type: string example: BICIS133742 blz: description: The (state local) bank code type: string example: '12345678' kreditinstitut: description: Name of financial institution type: string example: Demo-Bank inhaber: description: Full name of account holder type: string example: Dan Cooper example: id: DE89370400440532013000X status: VOLLSTAENDIG bezeichnung: Tagesgeldkonto kategorie: TAGESGELDKONTO saldo: 27365.56 aktualisierungszeitpunkt: '2021-10-15T09:13:44.000Z' saldoDatum: '2021-10-15T00:00:00.000Z' waehrung: EUR kontonummer: '9012345679' iban: DE89370400440532013000 bic: XXX12345678 blz: '12345678' kreditinstitut: Demo Provider inhaber: Fritz Testmüller SingleDebitData: allOf: - $ref: '#/components/schemas/PaymentBaseInfo' - $ref: '#/components/schemas/DebitBaseInfo' - title: SingleDebitData description: Request data to start a debit required: - debitDetails type: object properties: debitDetails: $ref: '#/components/schemas/DebitDetails' example: provider: ca650b48-3edc-45f4-938d-d21df8cba761 credentials: userid: mXlkGe+ukAEs+2iH ... D/MOfGsd8HY= pin: XO2jgZ ... 5GfhKpZmw= product: DE89370400440532013000 business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' SingleDebitDataBankAccess: allOf: - $ref: '#/components/schemas/DebitBaseInfo' - title: SingleDebitDataBankAccess description: Request data to start a single debit required: - debitDetails type: object properties: debitDetails: $ref: '#/components/schemas/DebitDetails' SingleDebitResult: allOf: - $ref: '#/components/schemas/Consent' - title: SingleDebitResult description: Current status of debit required: - debit type: object properties: debit: allOf: - $ref: '#/components/schemas/DebitBaseInfo' - required: - provider - product - paymentId - ebics - debitDetails type: object properties: provider: type: string format: uuid product: type: string paymentId: description: Unique id generated for each payment. type: string format: uuid ebics: description: Whether this debit was submitted via EBICS or not. type: boolean debitDetails: $ref: '#/components/schemas/DebitDetails' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/single-debit/07788639-abd7-4009-9c9d-2d79079f3f26 - rel: set_method href: >- https://banksapi.io/customer/v2/payment/single-debit/07788639-abd7-4009-9c9d-2d79079f3f26/consent debit: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 business: false sequenceType: OOFF creditorSchemeIdentification: GlauebigerId requestedCollectionDate: '2022-02-22T00:00:00.000Z' debitDetails: amount: 1337.42 currency: EUR purpose: Verwendungszweck endToEndId: '123' debtorName: Max Mustermann debtorIban: DE62430609671149278400 debtorAccountNumber: '1149278400' debtorBankCode: '43060967' debtorBic: GENODEM1GLS mandateIdentification: MandatsId mandateDateOfSignature: '2022-02-02T00:00:00.000Z' SingleTransferData: allOf: - $ref: '#/components/schemas/PaymentBaseInfo' - title: SingleTransferData description: Request data to start a transfer required: - transferDetails type: object properties: transferDetails: $ref: '#/components/schemas/TransferDetails' example: provider: ca650b48-3edc-45f4-938d-d21df8cba761 credentials: userid: mXlkGe+ukAEs+2iH ... D/MOfGsd8HY= pin: XO2jgZ ... 5GfhKpZmw= product: DE89370400440532013000 transferDetails: recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 1337.42 endToEndId: be7649876d5f439886fa816993ac9f9f SingleTransferResult: allOf: - $ref: '#/components/schemas/Consent' - title: SingleTransferResult description: Current status of transfer required: - transfer type: object properties: transfer: required: - provider - product - paymentId - ebics - transferDetails type: object properties: provider: type: string format: uuid product: type: string paymentId: description: Unique id generated for each payment. type: string format: uuid ebics: description: Whether this transfer was submitted via EBICS or not. type: boolean transferDetails: $ref: '#/components/schemas/TransferDetails' example: messages: - level: INFO code: BA3010 message: SCA Methode auswählen details: Bitte wählen Sie eine SCA-Methode aus scaMethods: - code: 2 name: mTAN hint: mTAN - code: 1 name: Mock-TAN hint: Mock-TAN relations: - rel: self href: >- https://banksapi.io/customer/v2/payment/single-transfer/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7 - rel: set_method href: >- https://banksapi.io/customer/v2/payment/single-transfer/3e97fa51-ce7b-42a0-9101-50fd67dbc3e7/consent transfer: provider: ca650b48-3edc-45f4-938d-d21df8cba761 product: DE89370400440532013000 transferDetails: recipient: netzpolitik.org e. V. purpose: Spende netzpolitik.de iban: DE62430609671149278400 bic: GENODEM1GLS currency: EUR amount: 1337.42 endToEndId: be7649876d5f439886fa816993ac9f9f SubmitScaData: title: SubmitScaData description: Supplies the consent process with needed information. type: object properties: chosenScaMethodId: description: Code of the SCA method type: string example: '942' chosenScaMedia: description: Name of the SCA medium type: string example: 'Mobile #1' scaAuthenticationData: type: string example: '123456' example: chosenScaMethodId: '942' SystemName: title: SystemName description: >- Machine-readable name of the tag, for a list check e.g. the [transaction categories](https://docs.banksapi.de) type: string example: BANKFINANCE TagInstanceSchema: properties: entity: $ref: '#/components/schemas/EntitySchema' id: description: Unique Universal Identifier (UUID) example: 956ca508-c0e2-52c5-3202-8de20e7ed12b type: string relations: description: List of relations items: $ref: '#/components/schemas/RelationSchema' type: array tagTreeItem: $ref: '#/components/schemas/TagTreeItemSchema' required: - entity - id - tagTreeItem type: object TagTreeItemSchema: properties: description: description: Gives a description of the tagTreeItem example: Expenses from daily grocery purchases type: string displayName: description: User-friendly name shown to the end-users example: Groceries type: string relations: description: List of relations items: $ref: '#/components/schemas/RelationSchema' type: array systemId: description: Unique internal id of the tag tree item example: 17 type: integer systemName: description: Unique name of the tag tree item example: LIVING_GROCERIES type: string systemNameParent: description: Unique name of the parent of the tagTreeItem example: LIVING type: string tagTree: $ref: '#/components/schemas/TagTreeSchema' required: - systemName - tagTree type: object TagTreeSchema: example: description: Two level categorization tree. version: 3.7 displayName: Kategorien isClientGenerated: false relations: - href: https://banksapi.io/tags/v1/tag-trees/1/ rel: self - href: https://banksapi.io/tags/v1/tag-trees/ rel: tag_trees - href: https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/ rel: tag_tree_items systemId: 1 systemName: CATEGORIES properties: description: description: Gives a description of the tag tree example: Detailed inusrance categories. type: string version: description: Version of the tag tree example: 1.5 minimum: 0 type: number displayName: description: User-friendly name shown to the end-users example: Kategorien type: string isTenantGenerated: description: Boolean flag, set TRUE if the tag was manually set example: true type: boolean relations: description: List of relations items: $ref: '#/components/schemas/RelationSchema' type: array systemId: description: Unique internal id of the tag tree example: 1 type: integer systemName: description: Unique name of the tag tree example: CATEGORIES type: string required: - systemName type: object Tag: title: Tag required: - tagScope - tagId - tagType - tagVersion - systemName - displayName - parent type: object properties: tagScope: description: Object of tagging. User or Transaction type: string tagId: description: Random unique id according to RFC4122 for identification type: string format: uuid tagType: $ref: '#/components/schemas/TagType' tagVersion: description: BANKSapi version of the tag hierarchy. type: integer format: int32 systemName: $ref: '#/components/schemas/SystemName' displayName: description: User-friendly and human readable name of the category in German type: string parent: $ref: '#/components/schemas/SystemName' example: tagScope: transaction tagId: 36d394ba-edef-4075-97e7-b19d1fae3702 tagType: CATEGORY tagVersion: '2.5' systemName: HOUSING_RENT displayName: Miete/Wohngeld parent: HOUSING TagType: title: TagType description: Type according to usage purpose enum: - null type: object example: CATEGORY TanMedium: title: TanMedium description: This object describes a TAN medium. type: object properties: name: description: Name of the TAN medium such as "Mobile" type: string medienklasse: description: >- Media classes:
  • `LISTE` - Paper-TAN list
  • `GENERATOR` - TAN generator
  • `MOBILE` - mobile phone
  • `SECODER` - TAN matrix generator
  • `PUSHTAN` - Push message
  • `ALL` - All classes
  • `PROPRIETARY` - Proprietary media class
  • type: string enum: - LISTE - GENERATOR - MOBIL - SECODER - PUSHTAN - ALL - PROPRIETARY gueltigVon: description: Date and time from which the TAN medium is valid. type: string format: YYYY-MM-DD hh:mm:ss gueltigBis: description: Date and time until which the TAN medium is valid. type: string format: YYYY-MM-DD hh:mm:ss example: gueltigVon: '2016-01-01T00:00:00.000Z' gueltigBis: '2016-12-31T23:59:59.000Z' name: +49-1111-11111 medienklasse: MOBIL TanMediumEn: title: TanMediumEn description: This object describes a TAN medium. type: object properties: name: description: Name of the TAN medium such as "Mobile" type: string mediaClass: description: >- Media classes:
  • `LIST` - Paper-TAN list
  • `GENERATOR` - TAN generator
  • `MOBILE` - mobile phone
  • `SECODER` - TAN matrix generator
  • `PUSHTAN` - Push message
  • `ALL` - All classes
  • `PROPRIETARY` - Proprietary media class
  • type: string enum: - LIST - GENERATOR - MOBILE - SECODER - PUSHTAN - ALL - PROPRIETARY validFrom: description: Date and time from which the TAN medium is valid. type: string format: YYYY-MM-DD hh:mm:ss validTo: description: Date and time until which the TAN medium is valid. type: string format: YYYY-MM-DD hh:mm:ss example: validFrom: '2016-01-01T00:00:00.000Z' validTo: '2016-12-31T23:59:59.000Z' name: +49-1111-11111 mediaClass: MOBILE Tenant: title: Tenant description: >- The tenant object represents our client. It plays a role in using the API only insofar that the tenant name is a URL component in the management API. type: object required: - name properties: description: description: Optional human readable description type: string name: description: Tenant technical name becomes URL component type: string example: description: A tenant for demonstration purposes name: demo Token: title: Token description: >- The OAuth2 token is basically a string that is passed around in the communication between our services and you, and to which certain permissions depend. type: object required: - scope - tenant - client - access_token - token_type properties: scope: description: >- Space-separated list of OAuth2 scopes. A scope names a class of access rules. It is a string, usually in the form of a (fictitious) URL. The available scopes depend on the scope of services booked. You therefore receive the scope list together with your cooperation agreement. type: string tenant: description: Technical name of the tenant type: string client: description: Technical name of the client type: string user: description: User reference, only set if this is a user token type: string additionalData: description: An optional list of additional data as a key-value map. type: object additionalProperties: type: string validTo: type: string format: YYYY-MM-DD hh:mm:ss access_token: description: The token type: string format: uuid token_type: description: Always "Bearer" type: string example: scope: >- http://banksapi.io/provider/read http://banksapi.io/schedule/read http://banksapi.io/customer/read http://banksapi.io/customer/modify http://banksapi.io/customer/ueberweisung auth/tenants/users/create tenant: demo client: demo-client user: CN=Some User,OU=Personal,DC=banksapi,DC=io additionalData: username: someuser validTo: '2021-10-16T10:46:47.000Z' access_token: be9e0b8e-8cff-45ff-8d95-f6bfa2eac7b9 token_type: Bearer Transaction: allOf: - title: Transaction type: object properties: id: description: The unique id of this transaction. type: string format: uuid hash: type: string format: uuid example: ad90f946-7f6d-3ec8-a6f2-fdf74df5138c example: id: ced1172c-0839-428a-af0d-8b87508f0981 hash: c478c333-910f-465c-8e7d-616d86a07c0e betrag: -70 verwendungszweck: EC 68096654 140215204106OC3 Ref. 5CC15048A1824480/89280 buchungsdatum: '2016-11-17T00:00:00.000Z' wertstellungsdatum: '2016-11-15T00:00:00.000Z' gegenkontoInhaber: La Sopia GmbH München gegenkontoIban: DE00123456789012345679 gegenkontoBic: XXX12345678 primanotaNummer: '421337' - $ref: '#/components/schemas/TransactionData' TransactionData: title: Transaction Data required: - betrag - verwendungszweck - gegenkontoInhaber - buchungsdatum type: object properties: tags: type: array items: $ref: '#/components/schemas/TagInstanceSchema' betrag: description: Amount with two decimal places. type: number example: -64.55 waehrung: description: Currency of the transaction. type: string example: EUR verwendungszweck: description: The purpose of the transaction. type: string example: EC 68096654 140215204106OC3 Ref. 5CC15048A1824480/89280 buchungstext: description: A text for the entry of the transaction type: string buchungsdatum: description: The date of the entry of the transaction type: string format: YYYY-MM-DD hh:mm:ss example: '2016-05-23T13:37:00.000Z' wertstellungsdatum: description: Date of booking type: string format: YYYY-MM-DD hh:mm:ss example: '2016-11-15T00:00:00.000Z' gegenkontoInhaber: description: Owner of the counter account type: string example: La Sopia GmbH München gegenkontoIban: description: IBAN of the counter account type: string example: DE00123456789012345679 gegenkontoBic: description: BIC of the counter account type: string example: XXX12345678 gegenkontoInhaberAbweichend: description: Ultimate owner of the counter account type: string example: La Sopia GmbH München primanotaNummer: description: Primanota number of sales type: string example: '421337' gvCode: description: Provider specific code, that denotes transaction use cases type: string example: '302' identifier: type: object properties: endToEndId: type: string proprietaryCode: description: Used for example for PayPal's proprietary transaction ID type: string entryReference: type: string ownerRef: type: string bookingRef: type: string balance: type: number mandateId: description: Contains the SEPA mandate reference type: string batchId: type: string example: betrag: -70 verwendungszweck: EC 68096654 140215204106OC3 Ref. 5CC15048A1824480/89280 buchungsdatum: '2016-11-17T00:00:00.000Z' wertstellungsdatum: '2016-11-15T00:00:00.000Z' gegenkontoInhaber: La Sopia GmbH München gegenkontoIban: DE00123456789012345679 gegenkontoBic: XXX12345678 primanotaNummer: '421337' TransferDetails: title: TransferDetails description: >- TransferDetails are used in InitiateSingleTransfer and InitiateBulkTransfer required: - recipient - purpose - iban - amount - currency type: object properties: recipient: description: Receiver of the transfer type: string purpose: description: Purpose of the transfer type: string iban: description: IBAN of the recipient account type: string bic: description: BIC of the recipient account type: string currency: description: Currency of the transfer (Alphabetic Code ISO 4217) type: string amount: description: Transfer amount type: number endToEndId: description: End-to-end identification of the transfer type: string purposeCode: description: >- Code to further classify payment using an [ISO20022 External Code](https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets) type: string example: SALA, DIVD, PENS, LOAN, ... ultimateDebtor: description: Ultimate debtor if deviating from account holder type: string ultimateCreditor: description: Ultimate creditor if deviating from recipient type: string UeberweisungDetails: allOf: - title: UeberweisungDetails description: >- UeberweisungDetails are used in CreateTransfer and CreateBulkTransfer required: - empfaenger - verwendungszweck - iban - betrag - waehrung type: object properties: empfaenger: description: Receiver of the transfer type: string verwendungszweck: description: Purpose of the transfer. type: string iban: description: IBAN of the recipient account type: string bic: description: BIC of the recipient account type: string waehrung: description: Currency of the transfer (Alphabetic Code ISO 4217) type: string betrag: description: Transfer amount type: number User: title: User description: This object represents a user type: object required: - id - username properties: id: description: Technical ID for the user, is also used in URLs (`user-id`) type: string username: description: Username for creating an OAuth2 token type: string roles: description: Roles this user has type: array items: type: string example: userReference: 1c5b33f6-9c4d-11e6-ba80-480fcfb9550f username: demo-user WrappedTags: type: object properties: tags: type: array items: $ref: '#/components/schemas/TagInstanceSchema' ErrorMessage: type: object properties: code: description: HTTP Code type: string example: '400' message: description: error message type: string example: >- Tag with system name INSURANCE_LIF does not exist for tag tree CATEGORIES AuthRevokeTokenRequest: type: object properties: token: description: The token to be revoked type: string format: uuid EncryptPlaintextRequest: type: string CustomerBankAccessBuilderPushTransactionsRequest: type: array items: $ref: '#/components/schemas/TransactionData' CustomerBankAccessPaymentInitiateSingleTransferRequest: title: SingleTransferData description: Request data to start a transfer required: - transferDetails type: object properties: transferDetails: $ref: '#/components/schemas/TransferDetails' CustomerBankAccessPaymentInitiateBulkTransferRequest: title: BulkTransferData description: Request data to start a transfer required: - transferDetails type: object properties: transferDetails: type: array items: $ref: '#/components/schemas/TransferDetails' AuthGetActivatedUsersResponse: type: array items: $ref: '#/components/schemas/User' AuthGetTenantsResponse: type: array items: $ref: '#/components/schemas/Tenant' EncryptPlaintextResponse: type: string ProvidersGetAllResponse: type: array items: $ref: '#/components/schemas/Provider' ProvidersListCoreDataResponse: type: array items: $ref: '#/components/schemas/ProviderCoreData' ProvidersGetJobStatisticsResponse: type: array items: $ref: '#/components/schemas/ProviderJobStatistics' CustomerBankAccessGetBankAccessChallengePdfResponse: type: string format: binary CustomerBankAccessGetTransactionsResponse: type: array items: $ref: '#/components/schemas/Transaction' CustomerBankAccessGetDepotPositionsResponse: type: array items: $ref: '#/components/schemas/Investment' requestBodies: CreateUser: description: The request body is a JSON object containing data required for a user content: application/json: schema: $ref: '#/components/schemas/CreateUser' example: username: demouser password: secret firstname: demo lastname: user required: true SubmitScaData: content: application/json: schema: $ref: '#/components/schemas/SubmitScaData' example: chosenScaMethodId: '2' required: true links: self: description: >- Returns the corresponding entity (e.g. bank access, single transfer, consent...) get_bankzugaenge: operationId: GetBankAccesses description: Lists all bank accesses of the user add_bankzugaenge: operationId: AddBankAccess description: adds a new bank access to the user refresh_bankzugang: operationId: RefreshBankAccess description: refreshes an existing bank access delete_bankzugang: operationId: DeleteBankAccess description: Deletes a bank access of the user parameters: access-id: $response.body#/id delete_bankzugaenge: operationId: DeleteBankAccesses description: Delete all bank accesses of the user get_kontoumsaetze: description: >- Lists all transactions of the given banking product, default are transactions of the last 90 days, available if product has transactions parameters: access-id: $request.path.access-id product-id: $request.path.product-id get_depotpositionen: description: >- Lists all depot positions of the given banking product, available if product has `kategorie` set to `DEPOT` and if depot positions are available parameters: access-id: $request.path.access-id product-id: $request.path.product-id start_sca: description: >- Handles a consent, available if an unhandled SCA occured in a previous bank access synchronisation parameters: access-id: $response.body#/id set_method: description: Sets `chosenScaMethodId`, available if current SCA requires it set_medium: description: Sets `chosenScaMedia`, available if current SCA requires it redirect_url: description: >- Contains link to the website, that the user needs to follow for the completion of the SCA authenticate: description: Sends `scaAuthenticationData`, available if current SCA requires it authenticate_decoupled: description: >- Polls current authentication status, available if current SCA requires to be completed on a different device or app delete_regprotect_sessions: description: Deletes all current REG/Protect sessions for the user get_issues: description: Shows issues for the given bank access parameters: access-id: $response.body#/id get_challenge_pdf: description: Returns the PDF file from the challenge if available parameters: access-id: $response.body#/id get_webform: description: Contains link to the REG/Protect web application cancel: description: Cancels current SCA, available if current SCA allows it initiate_single_transfer: operationId: InitiateSingleTransfer description: Initiates a single transfer initiate_bulk_transfer: operationId: InitiateBulkTransfer description: Initiates a bulk transfer initiate_single_transfer_with_saved_credentials: operationId: InitiateSingleTransferSavedCredentials description: Initiates a single transfer with previously saved credentials initiate_bulk_transfer_with_saved_credentials: operationId: InitiateBulkTransferSavedCredentials description: Initiates a bulk transfer with previously saved credentials get_single_transfer: description: Returns the corresponding single transfer, if available parameters: payment-id: $request.path.consent-id get_bulk_transfer: description: Returns the corresponding bulk transfer, if available parameters: payment-id: $request.path.consent-id get_single_debit: description: Returns the corresponding single debit, if available parameters: payment-id: $request.path.consent-id get_bulk_debit: description: Returns the corresponding bulk debit, if available parameters: payment-id: $request.path.consent-id get_kontoumsaetze_categories: description: Acts the same as `get_kontoumsaetze`, but with added category `tag`s parameters: access-id: $request.path.access-id product-id: $request.path.product-id get_kontoumsaetze_business_partners: description: >- Acts the same as `get_kontoumsaetze`, but with added business partner `tag`s parameters: access-id: $request.path.access-id product-id: $request.path.product-id get_kontoumsaetze_periods: description: Acts the same as `get_kontoumsaetze`, but with added period `tag`s parameters: access-id: $request.path.access-id product-id: $request.path.product-id get_kontoumsaetze_insurance_types: description: >- Acts the same as `get_kontoumsaetze`, but with added insurance type `tag`s parameters: access-id: $request.path.access-id product-id: $request.path.product-id get_kontoumsaetze_freelancer_categories: description: >- Acts the same as `get_kontoumsaetze`, but with added freelancer category `tag`s parameters: access-id: $request.path.access-id product-id: $request.path.product-id get_contracts: description: Returns the contracts of the user get_sales_triggers: description: Returns the sales trigger of the user get_life_events: description: Returns the life events of the user get_life_stages: description: Returns the life stages of the user get_cashflow: description: Returns the cashflow of the user get_credit_check: description: Returns the credit check of the user get_disposable_money: description: Returns the disposable money of the user get_affinities: description: Returns the affinities of the user get_credit_attributes: description: Returns the credit attributes of the user get_tagging_rules: description: Returns the manually created tagging rules of the user delete_tagging_rules: description: Deletes all tagging rules of the user add_tagging_rules: description: Adds a new tagging rule to the user logo: description: Returns the provider logo in an SVG-format parameters: provider-id: $request.path.provider-id securitySchemes: basicAuth: type: http scheme: basic httpBearer: type: http scheme: bearer security: - httpBearer: []