{"openapi":"3.1.0","servers":[{"url":"https://api.app.fizen.com","description":"Default server"},{"url":"https://api.sandbox.fizen.com","description":"Sandbox server"}],"info":{"title":"Fizen API definition","version":"latest","contact":{"name":"API Support","email":"support@fizen.com","url":"https://fizen.com"},"x-logo":{"url":"https://uploads-ssl.webflow.com/64bff36a2931cf7624e81393/64c018a99c416c19b06b7781_logo.svg","altText":"Fizen logo"}},"tags":[{"name":"Welcome","description":"Fizen sp. z o.o. is a licensed entity with an entry in the AISP register obtained from the Polish Financial Supervision Authority (KNF), enabling the provision of the account information access service (AIS).\n\nThe Fizen API enables business customers, with the consent of the account owner, to access banking data in a standardised form. To do this, the Fizen API requires the account owner to grant consent through the relevant bank interface. Fizen provides the Fizen Widget, which can be embedded in a page as an iframe, to support this process.\n\nIn addition, Fizen enables access to the technology of the Payment Initiation Service (PIS) for the entities who own a PISP licence using their production certificates.\n"},{"name":"Getting started","description":"\n**Access** **to** **API**\n\n Access to FIZEN API is secured with two-step authentication:\n\n- **API** **KEY** and **TOKEN** – these are confidential values provided by FIZEN that enable identification and connection with the FIZEN API infrastructure. The apiKey and token value are required with each request to the FIZEN API. The value should be placed in the request header as an apiKey and token.\n\n- **IP** **ADDRESS** – is the source of each request to the FIZEN API. Each query should be sent from a server with one public IP ADDRESS. Before starting the production use of FIZEN API, you must provide the IP ADDRESS of the server from which requests will be sent to FIZEN API. In the case of FIZEN API SANDBOX tests, the IP address is not verified.\n\nTo enable full communication with the Fizen API, you must also provide the URL to which we will send the following parameters:\n- AIS service - `state`, `userId`, `bankId`, `accounts[accountId]`, `consentExpirationDateTime`\n- PIS service - `state`, `userId`, `bankId`, `paymentStatus`, `amount`, `executionDate`\n \n**Initiation of AIS and PIS process**\n\nInitiation of services for AIS and PIS are based on the authorization of the user consent granted in the bank interface for access to the bank account. PIS initiation is based on initiating and authorising domestic payment for the retail account. Access to the service is available from the API or WIDGET level."},{"name":"Features","description":"\nFIZEN API, with the account owner's consent, grants access to a variety of account types, including retail, company, and corporate accounts. \nIt offers a comprehensive suite of features, such as domestic payments, future-dated payments, express transactions, bundled services, and recurring payments, all of which are provided for major commercial banks. \n\n - Poland:\n - PKO BP\n - Pekao SA\n - Erste Bank Polska\n - ING Bank Śląski\n - mBank\n - BNP Paribas Bank Polska S.A.\n - Bank Millennium\n - Alior Bank\n - Velo Bank\n - Credit Agricole\n - Bank Pocztowy\n - Bank Ochrony Środowiska\n - Nest Bank\n - Inteligo\n\n - Czech Republic:\n - Raiffeisen Czech Republic\n - UniCredit Czech Republic\n - Komerční banka\n - CSOB Czech Republic\n - Česká spořitelna (Erste)\n - Moneta Money Bank\n\n - Slovakia:\n - Slovenská sporiteľňa\n - Slovakia Tatra Banka\n - Raiffeisen Bank Slovakia\n - CSOB Banka\n - UniCredit\n - Prima Banka\n\n - Hungary:\n - Raiffeisenbank Hungary\n - Erste Bank Hungary\n - UniCredit Bank Hungary\n\n - Romania:\n - Raiffeisen Romania\n - UniCredit Bank Romania\n - Banca Comercială Română\n\n\n**FIZEN WIDGET**\n\nFIZEN WIDGET enables the complementary service of the end user by enabling the transfer of consent in the banking interface for access to data from the account.\n\n* It takes care of the user login to the banking interface. Confidential data such as login and password for end-user online banking will never pass through the client's server, thus eliminating the occurrence of security risks.\n* Integration is quick and easy\n\nThe process of giving consent by the user in the banking interface using FIZEN WIDGET is as follows:\n\n"},{"name":"Environments","description":"**FIZEN API Sandbox**\n\nBefore the production connection, Fizen enables access to the test environment, which is connected to real banking environments in sandbox mode. The environment allows you to fully download the test information about the user's account in order to test our technology. When using FIZEN SANDBOX, access to FIZEN WIDGET and FIZEN API is given.\n\nFIZEN API (sandbox) url address: https://api.sandbox.fizen.com/\n\nTo ensure the best possible user experience, we decided to make the following banks available in the test environment:\n - fizenbank (Our test bank implementation.)\n - ing\n - alior\n - mbank\n\nNormal working hours for the sandbox environment are from **8 AM to 6 PM UTC Time**. Outside of these hours, the environment enters a napping state. \nIf you decide to interact with it during non-operational hours, the environment will require 2 to 5 minutes to start up after the initial interaction.\n\nTest Data for bank sandboxes is available [here](https://docs.google.com/spreadsheets/d/1jmFf_hjz8SJ_eR9et80-SLSKOMjlKeoea42JLdoRGl8/edit#gid=1115838130)\n\nIn order to obtain access, apiKey and a token, please contact us at contact@fizen.com\n\n**FIZEN API Production**\n\nIn order to switch and gain access to the production FIZEN API environment, a request should be made by e-mail to contact@fizen.com along with the information about the IP ADDRESS that will be used to communicate with FIZEN API. After obtaining approval, the values of apiKey and a token will be sent to grant the establishment of production communication with the FIZEN API.\n\n- FIZEN API url address: https://api.app.fizen.com/"},{"name":"ip_addresses","x-displayName":"IP Addresses","description":"\nSecuring your scripts from potentially suspicious calls is advised. To achieve this, consider implementing IP address filtering for incoming connections. \n\nYou should be aware of the IP address ranges associated with Fizen servers:\n\n**Sandbox environment**\n\n**IP:** 34.118.93.200\n\n**Production environment**\n\n**IP:** 34.116.211.162, 34.118.70.53\n"},{"name":"lifetime","x-displayName":"State lifetime","description":"\nThe following table defines the lifetimes for the state depending on the type of operation\n\n | operation | lifetime |\n |-----------|-------|\n | AIS | 200 days | \n | PIS_DOMESTIC | 30 days | \n | PIS_EXPRESS | 30 days |\n | PIS_FUTURE | executionDate + 30 days |\n | CANCEL_PAYMENT | 30 days |\n | PIS_RECURRING | endDate + 30 days |\n | PIS_BUNDLE | latest executionDate + 30 days |"},{"name":"notifications","x-displayName":"Notifications","description":"\nWhenever the process of authorizing an account or ordering a transaction is successfully completed, information about it will be sent to pre-configured endpoints using the POST method.\n\nTo ensure correct communication via the POST method, three return addresses need to be configured:\n\n- Return address for the AIS service - dedicated for successful responses for account information access operations.\n\n- Return address for the PIS service - dedicated to handling successful responses for payment initialisation.\n\n- Return address for error handling - common to the AIS and PIS services, used when errors occur.\n\nEach of these addresses should be configured individually to ensure the correct operation of the respective processes.\n\n\nOnce the operation is successful, the following parameters are transferred via POST endpoints:\n\n **For AIS Service:**\n\n | parameter | description |\n |-----------|-------|\n | state | A unique identifier used to maintain the state between the authorization request and the callback. Ensures the integrity of the flow. | \n | userId | The unique identifier of the user initiating the AIS request. It helps the system identify and authenticate the specific user accessing account data. | \n | bankId | The identifier of the bank selected by the user. Specifies which bank's account information is being accessed. |\n | accounts | A list of account identifiers (IBANs or other account numbers) requested by the user for access. |\n | consentExpirationDateTime | Date and time when the user's consent expires. After this moment, access to account data is no longer allowed. |\n\n **For PIS Service:**\n \n | parameter | description |\n |-----------|-------|\n | state | A unique identifier used to maintain the state between the authorization request and the callback. Ensures the integrity of the flow. | \n | userId | The unique identifier of the user initiating the PIS request. It helps the system identify and authenticate the specific user accessing account data. | \n | bankId | The identifier of the bank selected by the user. Specifies which bank's account information is being accessed. | \n | paymentStatus | The current status of the payment process. Indicates whether the payment is pending, completed, failed, or in progress. |\n | amount | The total amount of the payment to be processed, typically provided in the format of a decimal value with currency. |\n | executionDate | (Optional) The date on which the payment is scheduled to be executed. Format: YYYY-MM-DD |\n\n The above parameters are necessary to complete the operation under the selected service.\n\n**Parameters** **transfer** **takes** **place** **in** **the** **following** **way:**\n\n- POST method - parameters are sent to the endpoint prepared on the client side. The endpoint must accept the following data structure:\n\n AIS service:\n \n {\n \"state\": \"ExAmPlEsTaT-5e83-11ed-a320-856ce1faa777\",\n \"userId\": \"exampleUserId\",\n \"bankId\": \"exampleBankId\",\n \"accounts\": [\n {\n \"accountId\": \"ExampleAccountIIVzdweGpkUS95OTNnOTdxMXZrOEk0QjUwOU1tU2iMA==\"\n },\n {\n \"accountId\": \"ExampleAccountIS9INW53c2k0M2g1cHFiN3pSWlRpKVFg0TWl1bFBncQ==\"\n }\n ]\n },\n\n PIS service:\n\n {\n \"state\": \"ExAmPlEsTaTece1a4cb6-5e83-11ed-a320-856ce1faa777\",\n \"userId\": \"exampleUserId\",\n \"bankId\": \"exampleBankId\",\n \"paymentStatus\": \"examplePaymentStatus\",\n \"amount\": \"0.01\"\n }\n\n **Possible Payment Statuses:** \n\n | Status | Description |\n |----------------|-----------------------------------------------------------------|\n | SUBMITTED | The payment has been successfully submitted and is awaiting execution. |\n | SCHEDULED | The payment is scheduled for a future date and awaits the specified date. |\n | PENDING | The payment is pending further verification or approval before execution. |\n | IN_PROGRESS | The recurring payment is correctly defined and executed according to the schedule, or bundle payments include at least one transaction with a future date (applies to the Fizen API). |\n | RECURRING_PLANNED | The recurring payment is correctly defined and executed according to the schedule (applies to FIZEN PAY). |\n | CANCELED | The payment has been canceled by the user or the system before execution. |\n | REJECTED | The payment has been rejected and will not be executed. |\n | DONE | The payment has been successfully executed and recorded in the recipient's account. |\n\n**Error notifications:**\n\nFor errors occurring during an AIS or PIS authorization flow, Fizen sends a POST request to the configured error callback endpoint. The error notification contains the bank response details when available:\n\n| parameter | description |\n|-----------|-------------|\n| errorId | A unique identifier for the error. |\n| errorDetails | A detailed message describing the error. |\n| bankId | Identifier of the bank related to the request. |\n| state | Unique state identifier used to track the request. |\n| userId | Unique user identifier. |\n| bankResponseCode | Optional response code returned by the bank. Included only when enabled in the client's configuration. |\n| bankResponseMessage | Optional response message returned by the bank. Included only when enabled in the client's configuration. |\n\nExample error notification:\n\n {\n \"errorId\": \"f9b8a9cd-...\",\n \"errorDetails\": \"Bank rejected the payment\",\n \"bankId\": \"mbank\",\n \"state\": \"d42fa...\",\n \"userId\": \"user-123\",\n \"bankResponseCode\": 430,\n \"bankResponseMessage\": \"Bank rejected the payment\"\n }\n\nError notifications are sent for asynchronous errors in the authorization flow. Status endpoints return errors synchronously in the HTTP response and do not generate an additional error notification POST.\n\n`bankResponseCode` and `bankResponseMessage` are optional fields. Their presence in the HTTP `430` response or error notification POST depends on the client's configuration. If the relevant option is disabled, these fields are omitted."},{"name":"fizen_pay_intro","x-displayName":"Introduction","description":"FizenPay is a payment page hosted by Fizen where users complete all the steps of the payment process: selecting the customer's bank, initializing the payment process, and redirecting to the bank service to allow the user to complete the payment.\nPayment is initiated through a dedicated endpoint, through this endpoint payment parameters are provided.\n"},{"name":"fizen_pay_flow","x-displayName":"Payment Flow","description":"The payment process begins with the generation of a payment link.\nThe user clicks on the link and is redirected to a panel to select the bank from which they want to make the payment.\n![Image Alt Text](https://storage.googleapis.com/fizenpay/fizenpayv2.jpg)\n\nOnce the payment is approved at the bank, the user is redirected to a screen with the status of the payment. \nFinally on the page we are expected to see a green status, which means that the payment was successful. \nRed x at the end means that payment failed. Once the final status is received, it also sends feedback to the addresses provided earlier.\n"},{"name":"fizen-pay-start","x-displayName":"Getting started","description":"To start working with the payment gateway it is necessary to generate the access keys for this purpose contact us.\nIn the next step, it is necessary to create a transaction by calling the API endpoint.\n"},{"name":"banks_list","x-displayName":"Banks List","description":"A list of available banks for AIS and PIS services along with redirecting to the chosen bank interface"},{"name":"consents","x-displayName":"Consents","description":"A list of available consents for Account Information Service (AIS), together with a complete consent management flow that allows clients to grant, verify, and revoke user consents in a transparent and controlled manner.\n\nThis part of the service provides full control over user consents, enabling clients to clearly manage which permissions have been granted.\n\nThrough dedicated endpoints, clients can:\n- retrieve the latest consent definitions configured for a given client\n- grant selected consents to a user based on a specific version\n- verify the current status of all consents assigned to a user\n- revoke previously granted consents at any time\n\nThis approach guarantees that access to user data is always aligned with explicitly granted permissions, supporting compliance with regulatory requirements and improving trust by giving clear visibility into how user consents are managed.\n\nAdditionally, the service integrates with the bank authorization flow, where the user is redirected to a bank interface to approve access. After successful authorization, the consent state is updated and can be managed via the available API operations.\n"},{"name":"analytics","x-displayName":"Analytics","description":"A set of endpoints that provides access to transaction summaries and analytical data for different payment types.\n\nThe analytics service allows clients to retrieve both detailed and aggregated transaction information for selected periods, helping them monitor activity, analyze payment execution, and support internal reporting processes.\n\nAvailable endpoints allow clients to:\n- get recurring transaction summaries\n- get bundle payment summaries\n- get overall transaction summaries across all transaction types\n\nReturned data may include transaction lists, daily statistics, SCA and non-SCA breakdowns, total number of transactions, and total transaction amounts.\n\nThis section is intended for reporting and analytical purposes only and does not participate in the transaction initiation process.\n\n**Important:** To access this part of the API, you need to contact Fizen Support to enable the required additional configuration.\n"},{"name":"ais-retail","x-displayName":"Account Information Service","description":"FIZEN API for AIS, or Account Information Service, provides individuals with access to information about their payment accounts.\nWith AIS, you can conveniently monitor the real-time status of your finances through various third-party applications. \nThis service empowers users to gain a holistic view of their financial transactions and balances, making it easier to manage their financial affairs and make informed decisions about their money.\nAIS is a key component of PSD2 (Payment Services Directive 2), promoting financial transparency and enhancing the user's ability to leverage innovative financial tools and services.\n"},{"name":"domestic-retail","x-displayName":"Domestic Payment","description":"FIZEN's Domestic Payment Services are responsible for processing domestic payments.\n\nIn this context, a domestic payment refers to a financial transaction in which funds are transferred from one bank \naccount to another within the same country or a specific geographical region, typically using the local currency. \nThese payments serve various purposes, including bill payments, transferring money to family and friends, making \npurchases, and settling financial obligations within the same country or region. It's important to distinguish domestic \npayments from international payments, which involve the transfer of funds between bank accounts located in different countries, \noften requiring currency conversion and compliance with international banking regulations.\n\nIt's important to highlight that payments initiated and approved by users through their banking service cannot be canceled.\nThis guarantees the successful delivery of payments, ensuring that once a user authorizes a transaction, it will be executed as scheduled. \nThis assurance contributes to the reliability and trustworthiness of the domestic payment service, giving users peace of mind regarding the arrival of their funds at the intended destination.\n"},{"name":"future-retail","x-displayName":"Future Date Payment","description":"FIZEN's Future Date Domestic Payment Services are responsible for processing domestic payments with a future date.\nThis specialized service operates in a manner similar to standard domestic payments but introduces the ability to schedule payments \nfor specific dates in the future. It allows users to proactively set up payments in advance, ensuring that financial commitments are met precisely when needed. \nFuture date domestic payments offer a valuable solution for planning and managing financial transactions within the same country or specific geographical region, \ngranting users greater flexibility and control over their payment schedules. It's important to emphasize that this service remains distinct from international payments, \nfocusing solely on domestic transactions and eliminating the complexities associated with cross-border transfers and currency conversion.\n\nIt's important to emphasize that this service allows for the cancellation of scheduled payments until the transfer is executed, providing users with complete control over their finances. \nThis feature ensures that users have the flexibility to modify or cancel future date domestic payments as needed, offering peace of mind and adaptability in managing their financial commitments.\n\nAdditionally, it's worth noting that this service also provides users with the option to lock funds in their account, in which case the cancellation of a transfer may not be possible. \n"},{"name":"express-retail","x-displayName":"Express Payment","description":"FIZEN's Express Domestic Payment Services are responsible for processing domestic payments with immediate delivery time. This specialized service operates similarly to standard domestic payments but with the added advantage of near-instantaneous transaction execution. Users can initiate and receive payments promptly, ensuring that funds are deposited directly into the recipient's account without delay, facilitating swift and efficient financial transactions."},{"name":"recurring-retail","x-displayName":"Recurring Payment","description":"FIZEN's Recurring Payment Services are responsible for processing payments on a recurring basis. \nThis specialized service functions similarly to standard payments but offers the added convenience of automated, \nscheduled payments that occur at regular intervals, such as monthly or weekly.\n\nUsers can set up recurring payments to meet their financial commitments without manual intervention, ensuring that \npayments are made consistently and on time. This feature provides users with the flexibility to establish and manage recurring financial transactions, streamlining their financial obligations.\nIt's worth noting that, like other payments with a future execution date, recurring payments can also be canceled until the scheduled payment date,\ngiving users full control over their recurring financial transactions and allowing for adjustments as needed.\n"},{"name":"bundle-retail","x-displayName":"Bundle Payment","description":"FIZEN's Bundle Payment Services are responsible for processing bundled payments. This specialized service operates similarly to standard payments but offers the added convenience of grouping multiple payments into a single, comprehensive transaction. Users can combine various payments into a bundle, streamlining their financial transactions and simplifying the management of multiple financial commitments. This feature allows for more efficient and organized payment processing."},{"name":"sepa-retail","x-displayName":"Sepa Payment","description":"FIZEN's SEPA Retail Payment Service enables individual customers to seamlessly initiate and manage international payments within the Single Euro Payments Area (SEPA). \nThis service is tailored for **personal transactions**, allowing individuals to transfer funds across European countries with the same ease as domestic payments.\n\nSEPA retail payments ensure **fast, secure, and standardized** cross-border transfers in **EUR**, eliminating the complexity of traditional international wire transfers. \nBy following SEPA standards, users can conduct international transactions **as efficiently as domestic ones**, ensuring compliance with European banking regulations.\n\n### Key Features:\n- **SEPA Credit Transfer (SCT) for Individuals**: Retail SEPA payments follow the SCT scheme, allowing **personal** international transfers with minimal fees.\n- **Cross-Border Transactions in EUR**: The transferred amount must be specified in **EUR**, regardless of the sender's local currency.\n- **Bank-Dependent Processing Times**: The completion time of SEPA retail payments depends on the recipient's bank and the standard cut-off times set by SEPA regulations.\n- **Mandatory Recipient Country Code**: Each SEPA transaction requires the **ISO 3166-1 alpha-3 country code** of the recipient’s bank to ensure accurate processing.\n- **Low-Cost International Transfers**: SEPA retail transactions are typically **cheaper** than traditional SWIFT payments, making them ideal for individuals.\n- **EU-Wide Standardization**: Ensures uniform rules across all SEPA member states, allowing users to make seamless transactions.\n\nThe **SEPA Retail Payment Service** provides a convenient, cost-effective, and reliable way for individuals to transfer money across European borders, ensuring smooth and predictable financial transactions. \nWith transparent processing and standardized banking practices, users can confidently send funds internationally without unexpected fees or delays.\n"},{"name":"ais-company","x-displayName":"Account Information Service","description":"FIZEN API for AIS, or Account Information Service, specifically caters to businesses, providing them with seamless access to information about their corporate payment accounts.\nThis service enables businesses to effortlessly monitor the real-time status of their finances through various third-party applications.\n\nAIS empowers corporate users to gain a comprehensive view of their financial transactions and balances, simplifying the management of their financial affairs and facilitating well-informed decision-making about their company's funds. \nThis heightened level of accessibility proves particularly valuable for businesses, offering streamlined monitoring of multiple accounts and supporting efficient financial planning.\n\nIt's crucial to recognize that AIS serves as a vital component of PSD2 (Payment Services Directive 2), contributing to financial transparency within the corporate sector. \nBy embracing AIS, businesses enhance their ability to leverage cutting-edge financial tools and services, fostering innovation and competitiveness in the financial landscape.\n"},{"name":"domestic-company","x-displayName":"Domestic Payment","description":"FIZEN's Domestic Payment Services play a crucial role in the seamless processing of payments within a specific country or geographical region.\n\nIn this context, a domestic payment involves the transfer of funds from one bank account to another within the same country, typically utilizing the local currency. \nThese payments serve a myriad of business purposes, including settling invoices, facilitating business-to-business transactions, managing payroll, and handling other financial obligations within the same country or region.\n\nIn the corporate context, domestic payments play a vital role in ensuring the smooth flow of financial operations. \nThis includes timely payment of suppliers and service providers, enabling seamless transactions between business entities, and maintaining financial stability within the local business environment.\n\nIt's crucial to recognize that domestic payments for business accounts are integral to maintaining strong financial relationships and supporting the overall financial health of the company. \nThis functionality is especially beneficial for businesses engaged in various sectors, contributing to the efficient management of financial resources and fostering a robust financial infrastructure.\n\nPayments initiated and approved by users through their banking service hold an irrevocable status. \nThis means that once a user authorizes a transaction, it will be executed as scheduled, and cancellations are not permitted. This commitment ensures the successful delivery of payments, contributing to the reliability and trustworthiness of the domestic payment service.\nUsers can have confidence that their funds will reach the intended destination securely and on time, reinforcing the dependability of the overall payment process.\n"},{"name":"recurring-company","x-displayName":"Recurring Payment","description":"FIZEN's Recurring Payment Services specialize in processing payments on a recurring basis, catering to both individual and business needs. \nThis dedicated service operates similarly to standard payments but offers the added convenience of automated, scheduled payments that occur at regular intervals, such as monthly or weekly.\n\nBusinesses, in particular, benefit from the capability to establish recurring payments, allowing them to meet ongoing financial commitments without manual intervention. \nThis ensures that payments are made consistently and punctually, contributing to the smooth operation of financial processes.\n\nThis feature provides users, including businesses with corporate accounts, the flexibility to set up and manage recurring financial transactions, streamlining their financial obligations efficiently.\nRecurring payments can be canceled until the scheduled payment date. This flexibility gives users, especially businesses, full control over their recurring financial transactions, allowing for adjustments as needed. \nThis adaptability is crucial for businesses managing recurring expenses associated with their corporate accounts.\n"},{"name":"bundle-company","x-displayName":"Bundle Payment","description":"FIZEN's Bundle Payment Services are responsible for processing bundled payments. This specialized service operates similarly to standard payments but offers the added convenience of grouping multiple payments into a single, comprehensive transaction. Users can combine various payments into a bundle, streamlining their financial transactions and simplifying the management of multiple financial commitments. This feature allows for more efficient and organized payment processing."},{"name":"sepa-company","x-displayName":"Sepa Payment","description":"FIZEN's SEPA Payment Service enables business account holders to initiate and manage international payments within the Single Euro Payments Area (SEPA).\nThis service operates similarly to domestic payments but is specifically designed for cross-border transactions in **EUR**, ensuring seamless processing across European financial institutions.\n\nWhen this service is used, payments are processed according to SEPA standards, allowing businesses to execute international transactions as efficiently as domestic ones.\nThis eliminates the need for traditional international wire transfers and ensures compliance with SEPA regulations.\n\n### Key Features:\n- **SEPA Standardized Processing**: Payments are executed using the SEPA Credit Transfer (SCT) scheme, ensuring compliance with European banking standards.\n- **Cross-Border Transactions in EUR**: Unlike domestic payments, SEPA transactions require the amount to be specified in **EUR**, regardless of the sender's local currency.\n- **Bank-Dependent Processing Times**: The completion time of SEPA payments depends on the recipient's bank and the standard cut-off times set by SEPA regulations.\n- **Mandatory Recipient Country Code**: Every SEPA transaction requires the **ISO 3166-1 alpha-3 country code** of the recipient’s bank, ensuring accurate routing.\n\nThe SEPA payment service provides businesses with a reliable and standardized method to process payments across European borders while maintaining real-time visibility over transaction statuses. \nBy leveraging this service, businesses can optimize international financial operations with enhanced efficiency and transparency.\n"}],"x-tagGroups":[{"name":"Getting started","tags":["Welcome","Getting started","Features"]},{"name":"General","tags":["Environments","ip_addresses","lifetime","notifications"]},{"name":"Fizen Pay","tags":["fizen_pay_intro","fizen_pay_flow","fizen-pay-start"]},{"name":"Fizen API","tags":["banks_list","consents","analytics"]},{"name":"Fizen API Retail","tags":["ais-retail","domestic-retail","future-retail","express-retail","recurring-retail","bundle-retail","sepa-retail"]},{"name":"Fizen API Company","tags":["ais-company","domestic-company","recurring-company","bundle-company","sepa-company"]}],"paths":{"/banks/list":{"get":{"tags":["banks_list"],"summary":"Banks List","description":"List of available banks to authorise a consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","operationId":"BanksList","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/banks/list' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'operationType: AIS' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"operationType","in":"header","description":"Specify service to access.","required":true,"schema":{"type":"string","enum":["AIS","PIS_DOMESTIC","PIS_RECURRING","PIS_BUNDLE","PIS_EXPRESS","PIS_FUTURE"]},"example":"AIS"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/fizen-consents/consents":{"get":{"tags":["consents"],"summary":"Get client consents definition","description":"Returns the latest version of consents configured for the client.\n\nRequired consents:\n **AIS_POLICY_ACCEPTANCE, AIS_PERSONAL_DATA_PROCESSING, AIS_DATA_TRANSFER**\n\nOptional consents:\n **AIS_DATA_TRANSFER_TO_THIRD_PARTY**\n","operationId":"GetClientConsents","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/fizen-consents/consents' \\\n--header 'apikey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=='\n"}],"parameters":[{"name":"apikey","in":"header","description":"API key assigned to the client (required in practice for authorization)","required":true,"schema":{"type":"string","example":"9693455a2698ff0316f14da3c30a18c97a4d0000"}},{"name":"token","in":"header","description":"Authorization token used to validate the request","required":true,"schema":{"type":"string","example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="}}],"responses":{"200":{"description":"Successfully returned client consents definition","content":{"application/json":{"schema":{"type":"object","description":"Response containing current consent definition for the client","properties":{"consents":{"type":"array","description":"List of available consents for the client","items":{"type":"object","description":"Single consent definition","properties":{"type":{"type":"string","description":"Type of consent","enum":["AIS_POLICY_ACCEPTANCE","AIS_PERSONAL_DATA_PROCESSING","AIS_DATA_TRANSFER","AIS_DATA_TRANSFER_TO_THIRD_PARTY"],"example":"AIS_POLICY_ACCEPTANCE"},"version":{"type":"integer","description":"Version of consents definition accepted by the user","example":3},"content":{"type":"string","description":"Full textual content of the consent shown to the user","example":"I agree to the processing of my personal data..."},"description":{"type":"string","description":"Optional description of the consent shown to the user","example":"Example descriptions of consent."},"isRequired":{"type":"boolean","description":"Indicates whether the consent is mandatory","example":true}}}}}}}}},"401":{"description":"Unauthorized - invalid or missing credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error - problem retrieving consents definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/fizen-consents/consents/{userId}":{"get":{"tags":["consents"],"summary":"Get user consents","description":"Returns consents assigned to a specific user along with their current status.\n\nRequired consents:\n **AIS_POLICY_ACCEPTANCE, AIS_PERSONAL_DATA_PROCESSING, AIS_DATA_TRANSFER**\n\nOptional consents:\n **AIS_DATA_TRANSFER_TO_THIRD_PARTY**\n","operationId":"GetUserConsents","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/fizen-consents/consents/user-123' \\\n--header 'apikey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=='\n"}],"parameters":[{"name":"apikey","in":"header","required":true,"schema":{"type":"string","example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},"description":"API key assigned to the client"},{"name":"token","in":"header","required":true,"schema":{"type":"string","example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},"description":"Authorization token"},{"name":"userId","in":"path","required":true,"schema":{"type":"string","example":"user-123"},"description":"Unique identifier of the user"}],"responses":{"200":{"description":"Successfully returned user consents","content":{"application/json":{"schema":{"type":"object","description":"User consents with current status","properties":{"consents":{"type":"array","description":"List of user consents","items":{"type":"object","description":"Single user consent","properties":{"type":{"type":"string","description":"Type of consent","enum":["AIS_POLICY_ACCEPTANCE","AIS_PERSONAL_DATA_PROCESSING","AIS_DATA_TRANSFER","AIS_DATA_TRANSFER_TO_THIRD_PARTY"],"example":"AIS_POLICY_ACCEPTANCE"},"version":{"type":"integer","description":"Version of consents assigned to the user","example":3},"content":{"type":"string","description":"Consent content from definition","example":"I agree to the processing of my personal data..."},"description":{"type":"string","description":"Optional description of the consent shown to the user","example":"Example descriptions of consent."},"status":{"type":"string","description":"Current status of the consent","enum":["GRANTED","REVOKED"],"example":"GRANTED"}}}}}}}}},"401":{"description":"Unauthorized - authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found - user does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/fizen-consents/consents/grant/{userId}":{"post":{"tags":["consents"],"summary":"Grant consents to user","description":"Assigns selected consents to a user. Updates existing ones if already present.\n\nRequired consents:\n **AIS_POLICY_ACCEPTANCE, AIS_PERSONAL_DATA_PROCESSING, AIS_DATA_TRANSFER**\n\nOptional consents:\n **AIS_DATA_TRANSFER_TO_THIRD_PARTY**\n","operationId":"GrantConsents","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/fizen-consents/consents/grant/user-123' \\\n--header 'apikey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"consentTypes\": [\n \"AIS_POLICY_ACCEPTANCE\",\n \"AIS_PERSONAL_DATA_PROCESSING\"\n ]\n}'\n"}],"parameters":[{"name":"apikey","in":"header","required":true,"schema":{"type":"string","example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},"description":"API key assigned to the client"},{"name":"token","in":"header","required":true,"schema":{"type":"string","example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},"description":"Authorization token"},{"name":"userId","in":"path","required":true,"schema":{"type":"string","example":"user-123"},"description":"Unique identifier of the user"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request containing consents to grant","required":["consentTypes"],"properties":{"consentTypes":{"type":"array","description":"List of consent types to grant","minItems":1,"uniqueItems":true,"items":{"type":"string","description":"Consent type","enum":["AIS_POLICY_ACCEPTANCE","AIS_PERSONAL_DATA_PROCESSING","AIS_DATA_TRANSFER","AIS_DATA_TRANSFER_TO_THIRD_PARTY"],"example":"AIS_POLICY_ACCEPTANCE"}}}}}}},"responses":{"204":{"description":"Consents successfully granted"},"400":{"description":"Bad Request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/fizen-consents/consents/revoke/{userId}":{"post":{"tags":["consents"],"summary":"Revoke consents from user","description":"Revokes selected consents for a user.\n\nRequired consents:\n **AIS_POLICY_ACCEPTANCE, AIS_PERSONAL_DATA_PROCESSING, AIS_DATA_TRANSFER**\n\nOptional consents:\n **AIS_DATA_TRANSFER_TO_THIRD_PARTY**\n","operationId":"RevokeConsents","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/fizen-consents/consents/revoke/user-123' \\\n--header 'apikey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"consentTypes\": [\n \"AIS_POLICY_ACCEPTANCE\",\n \"AIS_PERSONAL_DATA_PROCESSING\"\n ]\n}'\n"}],"parameters":[{"name":"apikey","in":"header","required":true,"schema":{"type":"string","example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},"description":"API key assigned to the client"},{"name":"token","in":"header","required":true,"schema":{"type":"string","example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},"description":"Authorization token"},{"name":"userId","in":"path","required":true,"schema":{"type":"string","example":"user-123"},"description":"Unique identifier of the user"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request containing consents to revoke","required":["consentTypes"],"properties":{"consentTypes":{"type":"array","description":"List of consent types to revoke","minItems":1,"uniqueItems":true,"items":{"type":"string","description":"Consent type","enum":["AIS_POLICY_ACCEPTANCE","AIS_PERSONAL_DATA_PROCESSING","AIS_DATA_TRANSFER","AIS_DATA_TRANSFER_TO_THIRD_PARTY"],"example":"AIS_POLICY_ACCEPTANCE"}}}}}}},"responses":{"204":{"description":"Consents successfully revoked"},"400":{"description":"Bad Request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/{bankId}/initiate/{redirectUri}":{"get":{"tags":["ais-retail"],"summary":"Start Linking Process","description":"The process of gaining access to the user's account begins with the generation of redirect URL to the bank's interface, \nwhere the user can grant consent for access to their account information.\nAfter successfully completing the bank's process the user will be redirected to the specified redirect URL,and a callback with the relevant data will be sent.\n\n### **State Grouping for Extended Banking Transaction Access**\n\nThis feature allows **grouping of consents (states)** so that multiple states within the same group **can share tokens**, extending the time frame for fetching transactions beyond standard banking limits.\n\n### **Purpose**\n- Many banks impose strict time limits on transaction retrieval using a single consent (state).\n- For example, **PKO BP allows only up to 4 hours**, after which a new consent is required.\n- This solution will allow fetching transactions for at least **10 hours**, which for **PKO BP** would require three separate consents for the same account.\n\n### **How It Works**\n- **States will be grouped by the `userId` parameter**.\n- To belong to the same group, states must have the **same `userId`, `bank`, or client `apiKey`**.\n- If a **`userId` is not provided**, the state **will not be assigned to any group**.\n","operationId":"startLinking","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'userId: 123' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n--header 'limitedScope: true' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"userId","in":"header","description":"The ID of the end user who agreed to provide access to the account information. ID generated on the client's side and passed to API FIZEN.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system.","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The address of the page to which the user will be redirected after completing the data sharing authorization process","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"limitedScope","in":"header","description":"Value informs whether access to the account will be limited to basic data.","required":true,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/AisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/{bankId}/account/{accountId}":{"get":{"tags":["ais-retail"],"summary":"Account Details","description":"This endpoint allows obtaining detailed information about the user's account for which they have previously granted consent, \nincluding information such as account owner, account number, account currency, available account balance, and account description.\nThe data returned by our system depends on the information provided by each respective bank. As a result, the details of the response may vary between different banks. \nUsers should account for potential differences in available data when integrating with our API.\n","operationId":"getAccountDetails","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/account/{accountId}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","required":true,"schema":{"type":"string"},"example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},{"name":"accountId","in":"path","description":"The bank account ID to which the end user has consented to provide access to the account information. One of the values necessary to query information about an account","required":true,"schema":{"type":"string"},"example":"VmhJQ0lKSHBKcEJ4TXByNHE2U3BKMG1SU3JXYStFVXBISDdCQUhLaHJXcz0="},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDetailsResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}/account/{accountId}/transactions":{"get":{"tags":["ais-retail"],"summary":"Account Transactions","description":"This endpoint enables access to the transaction history for a specific account number for which consent has been obtained previously.\nThe data returned by our system depends on the information provided by each respective bank. As a result, the details of the response may vary between different banks.\nUsers should account for potential differences in available data when integrating with our API.\n\nIf certain transaction types cannot be retrieved due to an issue (e.g., database timeout, temporary service unavailability), \nthe response will still contain the successfully retrieved transactions and will also include a new field: \n**`transactionsStatusesFetchFailures`**, which lists the transaction types that **failed to be fetched**.\n\nIf **all** transaction types fail to be retrieved:\n- The **transactions list will be empty**.\n- The **`transactionsStatusesFetchFailures` field will include all requested transaction types**.\n\nExample Scenarios:\n- Only `DONE` transactions fail for **mBank**.\n- Two transaction types fail for **Pekao**.\n- All transaction types fail for **Erste**.\n\n## Exception Handling\nThere is one exception to this mechanism: \n**If the request exceeds the operation limit**, the system will return an explicit error response **without including the transactions list or the `transactionsStatusesFetchFailures` field**. \nIn this case, the client must retry the request after resolving the issue (e.g., reducing the number of transactions requested).\n","operationId":"getTransactions","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/account/{accountId}/transactions' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","required":true,"schema":{"type":"string"},"example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},{"name":"tradeDateFrom","in":"header","description":"Start date from which data should be returned (inclusive). The date must be in the past\n(earlier than today; today's date is not allowed). Expected format is ISO 8601 date (YYYY-MM-DD).\n","required":false,"schema":{"type":"string"},"example":"2026-01-01"},{"name":"accountId","in":"path","description":"The bank account ID to which the end user has consented to provide access to the account information. One of the values necessary to query information about an account","required":true,"schema":{"type":"string"},"example":"VmhJQ0lKSHBKcEJ4TXByNHE2U3BKMG1SU3JXYStFVXBISDdCQUhLaHJXcz0="},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"includeAllTransactionStatuses","in":"header","description":"Optional flag controlling which transaction statuses are returned in the response.\n\nBy default (when the header is not provided or set to false), the API returns only\ntransactions with the following statuses: DONE, PENDING, HOLD.\nTransactions with statuses REJECTED, CANCELED, and SCHEDULED are excluded.\n\nWhen set to true, the API returns all available transaction statuses,\nincluding REJECTED, CANCELED, and SCHEDULED (if such transactions exist\nfor the given bank/account).\n","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionListResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}/KYC/{accountId}":{"get":{"tags":["ais-retail"],"summary":"KYC","description":"This service provides a transparent way to access the user's identity by leveraging the granted consent for account access. It provides a field containing crucial information, such as the user's name and address, for precise user identification.","operationId":"getKYCDetails","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/KYC/{accountId}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","required":true,"schema":{"type":"string"},"example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},{"name":"accountId","in":"path","description":"The bank account ID to which the end user has consented to provide access to the account information. One of the values necessary to query information about an account","required":true,"schema":{"type":"string"},"example":"VmhJQ0lKSHBKcEJ4TXByNHE2U3BKMG1SU3JXYStFVXBISDdCQUhLaHJXcz0="},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycDetailsResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}/payment/initiate/{redirectUri}":{"get":{"tags":["domestic-retail"],"summary":"Start Payment Process","description":"The payment initialization endpoint serves as a crucial access point for initiating domestic payment processes. \nIn response to this endpoint, a redirect URL is generated, directing the user to the bank's authorization page.\n\nOn the bank's page, the user has the opportunity to verify the accuracy of the payment details required for the transfer and to confirm the payment. \nOnce the payment is approved by the user, they will be redirected to the previously defined page, and the transaction data will be transmitted via a callback.\n\nWhen making a payment, you have the option to perform a **split payment**. \n\nThe split payment mechanism is a payment system in which the amount of VAT, which is separated from the gross amount due to the seller, \nis transferred to a separate bank account, called a VAT account, to which the seller has limited access.\n\nTo successfully initiate a split payment, you **must provide all four parameters**: \n `spInvoiceNumber`, `spTaxIdentificationNumber`, `spTaxAmount`, `spDescription`. \n\nIf at least one of these parameters is provided but others are missing, the split payment request will be rejected.\n\nSplit payment for retail transactions is available for specific banks because payments from sole proprietorship accounts are processed through this banking endpoint.\nThe list of supported banks includes: `mBank`, `BNP Paribas`, `NEST`, `Alior`, `Credit Agricole`, `Velo`.\n","operationId":"startPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/payment/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'amount: 0.99' \\\n--header 'recipientAccountNumber: PL12345678901234567890123456' \\\n--header 'recipientNameAddress: Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz' \\\n--header 'userId: 123' \\\n--header 'title: FV/1234/22' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n--header 'spInvoiceNumber: INV001/2023/24' \\\n--header 'spTaxIdentificationNumber: 7242354073' \\\n--header 'spTaxAmount: 23.00' \\\n--header 'spDescription: VAT for January services'\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"","Payment amount. Format":"d+.d{2}","required":true,"schema":{"type":"string"},"example":0.99},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"}},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config. To handle Polish characters, URL encoding is necessary.","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"spInvoiceNumber","in":"header","description":"Payment Invoice Number (Required for split payment mechanism)","required":false,"schema":{"type":"string"},"example":"INV001/2023/24"},{"name":"spTaxIdentificationNumber","in":"header","description":"Tax Identification Number (NIP) (Required for split payment mechanism)","required":false,"schema":{"type":"string"},"example":3788796687},{"name":"spTaxAmount","in":"header","description":"Amount of VAT tax (Required for split payment mechanism)","required":false,"schema":{"type":"string"},"example":460},{"name":"spDescription","in":"header","description":"A brief description of the payment (Required for split payment mechanism)","required":false,"schema":{"type":"string"},"example":"VAT for January services"},{"name":"senderAccountNumber","in":"header","description":"Sender Account Number in IBAN format. Value required if Sender Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"}},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A transfer title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]). To handle Polish characters, URL encoding is necessary.","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"redirectUri","in":"path","description":"The address of the page to which the user will be redirected after completing the data sharing authorization process","required":true,"schema":{"type":"string"},"example":"https://redirect-url.com"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment (Get Domestic Payment)":{"get":{"tags":["domestic-retail"],"summary":"Payment status","description":"The \"Get Payment Status\" endpoint allows customers to check the status of their payments. When this endpoint is called, \nthe system returns the current status of a specific payment, enabling users to track the progress and history of their transactions.\n\nThis functionality provides users with real-time access to the status of their payments, offering transparency and visibility into their financial transactions.\nHowever, the returned payment statuses may vary depending on the bank, and the timing of status updates can also differ based on the bank's processing schedule.\n","operationId":"getPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/payment' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}/payment/future/initiate/{redirectUri}":{"get":{"tags":["future-retail"],"summary":"Start Payment Process","description":"The \"Initiate Future Date Payment\" endpoint serves as a crucial access point for initiating future-dated payment processes. \nUpon calling this endpoint, a redirect URL is generated in response, directing the user to the bank's authorization page.\n\nOn the bank's page, users have the opportunity to verify the accuracy of the payment details required for the future-dated transfer and to confirm the payment.\nOnce the payment is approved by the user, they will be redirected to the previously defined page, and the transaction data will be transmitted via a callback.\n","operationId":"startPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/payment/future/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'amount: 0.99' \\\n--header 'executionDate: 2024-08-16' \\\n--header 'recipientAccountNumber: PL12345678901234567890123456' \\\n--header 'recipientNameAddress: Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz' \\ \n--header 'userId: 123' \\\n--header 'title: FV/1234/22' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"","Payment amount. Format":"d+.d{2}","required":true,"schema":{"type":"string"},"example":0.99},{"name":"executionDate","in":"header","description":"Payment execution date","required":true,"schema":{"type":"string","format":"date-time"},"example":"2025-02-10"},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config. To handle Polish characters, URL encoding is necessary.","required":false,"schema":{"type":"string"}},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config. To handle Polish characters, URL encoding is necessary.","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A transfer title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]).","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The URL to which the user will be redirected after authorization is completed.","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment (Get Future Payment)":{"get":{"tags":["future-retail"],"summary":"Future Payment Status","description":"The \"Get Future Date Payment Status\" endpoint enables customers to check the status of their future-dated payments. \nUpon calling this endpoint, the system retrieves and returns the current status of a specific future-dated payment. \nThe returned payment statuses may vary depending on the bank, and the timing of status updates can also differ based on the bank's processing schedule.\nThis feature empowers users to monitor the status of their future-dated transactions in real-time.\n","operationId":"getFuturePayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/payment' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}/payment/cancel/initiate/{redirectUri}":{"get":{"tags":["future-retail"],"summary":"Start Cancel Payment Process","description":"The \"Cancel Future Date Payment\" endpoint allows users to cancel future-dated payments. Similar to the \"Cancel Recurring Payment\" process, this functionality generates a redirect URL in response, directing the user to the bank's authorization page.\n\nOn the bank's page, users have the opportunity to verify the accuracy of the cancel payment request details required for the transfer cancellation and to confirm the operation.\nOnce the cancel payment request is approved by the user, they will be seamlessly redirected to the previously defined page, and the cancellation status data will be transmitted via a callback.\n","operationId":"startCancelPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/payment/cancel/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: ExAmPlEsTaTece1a4cb6-5e83-11ed-a320-856ce1faa777' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"}},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A transfer title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]).","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The URL to which the user will be redirected after authorization is completed.","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/{bankId}/payment/express/initiate/{redirectUri}":{"get":{"tags":["express-retail"],"summary":"Start payment process","description":"The 'Express Payment Initialization' endpoint serves as a vital entry point for initiating express payment processes.\nSimilar to the standard payment initialization endpoint, this endpoint generates a redirect URL in response, directing the user to the bank's authorization page.\n\nOn the bank's page, users have the opportunity to verify the accuracy of the payment details required for the transfer and \nconfirm the payment swiftly. Once the user approves the payment, they will be seamlessly redirected to the previously defined page, and the transaction data will be transmitted via a callback.\n","operationId":"startExpressPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/payment/express/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'amount: 0.99' \\\n--header 'recipientAccountNumber: PL12345678901234567890123456' \\\n--header 'recipientNameAddress: Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz' \\\n--header 'userId: 123' \\\n--header 'title: FV/1234/22' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"","Payment amount. Format":"d+.d{2}","required":true,"schema":{"type":"string"},"example":0.99},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"}},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A transfer title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]).","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"redirectUri","in":"path","description":"The address of the page to which the user will be redirected after completing the data sharing authorization process","required":true,"schema":{"type":"string"},"example":"https://redirect-url.com"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment (Get Express Payment)":{"get":{"tags":["express-retail"],"summary":"Express Payment Status","description":"The \"Get Express Payment Status\" endpoint allows customers to check the status of their express payments. \nUpon calling this endpoint, the system retrieves and returns the current status of a specific express payment. \nThis feature empowers users to monitor the progress and history of their express transactions in real-time.\nThe returned payment statuses may vary depending on the bank, and the timing of status updates can also differ based on the bank's processing schedule.\n","operationId":"getExpressPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/payment' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}/payment/sepa/initiate/{redirectUri}":{"get":{"tags":["sepa-retail"],"summary":"SEPA Payment Initiation","description":"FIZEN's SEPA Retail Payment Service enables individual customers to seamlessly initiate and manage international payments within the Single Euro Payments Area (SEPA). \nThis service is tailored for **personal transactions**, allowing individuals to transfer funds across European countries with the same ease as domestic payments.\n\nThe **SEPA Retail Payment Service** provides a convenient, cost-effective, and reliable way for individuals to transfer money across European borders, ensuring smooth and predictable financial transactions. \nWith transparent processing and standardized banking practices, users can confidently send funds internationally without unexpected fees or delays.\n","operationId":"startSepaPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/mbank/payment/sepa/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'Content-Type: application/json' \\\n--header 'recipientAccountNumber: DE89370400440532013000' \\\n--header 'recipientNameAddress: John Doe Hauptstrasse 10 10115 Berlin' \\\n--header 'currency: EUR' \\\n--header 'recipientCountryCode: DEU' \\\n--header 'userId: 123' \\\n--header 'title: bike' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0'\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"Payment amount in EUR (format: d+.d{2})\n","required":true,"schema":{"type":"string"},"example":"1000.00"},{"name":"currency","in":"header","description":"Currency for SEPA payments (always EUR)","required":true,"schema":{"type":"string","enum":["EUR"]},"example":"EUR"},{"name":"recipientAccountNumber","in":"header","description":"Recipient's IBAN (International Bank Account Number)","required":true,"schema":{"type":"string"},"example":"DE89370400440532013000"},{"name":"recipientNameAddress","in":"header","description":"Recipient's full name and address","required":true,"schema":{"type":"string"},"example":"John Doe, 123 Berlin Street, 10117 Berlin"},{"name":"recipientCountryCode","in":"header","description":"ISO 3166-1 alpha-3 country code of the recipient’s bank","required":true,"schema":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"example":"DEU"},{"name":"senderAccountNumber","in":"header","description":"Sender's IBAN, required if not pre-configured in Fizen","required":false,"schema":{"type":"string"},"example":"FR7630006000011234567890189"},{"name":"userId","in":"header","description":"Unique user identifier, generated on the client's side","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"Transfer title (5-80 characters). For mBank, the use of \":\" is not allowed","required":false,"schema":{"type":"string"},"example":"SEPA Payment Invoice 1234/24"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"Browser agent identifying the end user's browser and OS","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"bankId","in":"path","description":"Bank identifier for authorization of SEPA payment","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"redirectUri","in":"path","description":"Redirect URL where the user will be sent after authorization","required":true,"schema":{"type":"string"},"example":"https://redirect-url.com"}],"responses":{"200":{"description":"OK - SEPA Payment Initiated Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request - Invalid Input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found - Invalid Endpoint or Missing Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment (Get Sepa Payment Retail)":{"get":{"tags":["sepa-retail"],"summary":"SEPA Payment Status","description":"The \"Get SEPA Payment Status\" endpoint allows business account holders to seamlessly check the status of their SEPA payments within the Single Euro Payments Area (SEPA). \nWhen this endpoint is invoked, the system promptly returns the current status of a specific SEPA payment, enabling business users to track their international transactions efficiently.\n\n### Key Features:\n- **Real-Time Tracking**: Businesses receive up-to-date payment statuses, ensuring they remain informed about their transactions.\n- **Cross-Border SEPA Monitoring**: Unlike domestic payments, SEPA transactions involve additional processing layers and may experience variations in update frequency based on the involved banks.\n\nThe returned SEPA payment statuses may vary depending on the recipient's bank and country, and the timing of updates may differ due to international banking regulations and cut-off times.\n","operationId":"getSepaPaymentStatus","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/mbank/payment/sepa/status' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK - SEPA Payment Status Retrieved Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request - Invalid Input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found - Payment Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}/payment/recurring/initiate/{redirectUri}":{"get":{"tags":["recurring-retail"],"summary":"Start Payment Process","description":"The \"Initiate Recurring Payment\" endpoint streamlines the initiation of recurring payment processes. \nUpon calling this endpoint, a redirect URL is generated in response, directing the user to the bank's authorization page.\n\nOn the bank's page, users have the opportunity to verify the accuracy of the payment details required for the recurring transfer and to confirm the payment.\nOnce the payment is approved by the user, they will be redirected to the previously defined page, and the transaction data will be transmitted via a callback.\n","operationId":"startPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/payment/recurring/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'amount: 0.99' \\\n--header 'recipientAccountNumber: PL12345678901234567890123456' \\ \n--header 'recipientNameAddress: Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz' \\ \n--header 'period: WEEK' \\\n--header 'startDate: 2024-02-10' \\\n--header 'endDate: 2025-02-10' \\\n--header 'userId: 123' \\\n--header 'title: FV/1234/22' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"","Payment amount. Format":"d+.d{2}","required":true,"schema":{"type":"string"},"example":0.99},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"PL12345678901234567890123456"},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"period","in":"header","description":"payment frequency","required":true,"schema":{"type":"string","enum":["WEEK","MONTH","YEAR"]},"example":"WEEK"},{"name":"startDate","in":"header","description":"Recurring payment start date. The date must be in the future (later than the current date).\nExpected format is ISO 8601 date (YYYY-MM-DD).\n","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-02-10"},{"name":"endDate","in":"header","description":"Recurring payment end date. Expected format is ISO 8601 date (YYYY-MM-DD).","required":true,"schema":{"type":"string","format":"date-time"},"example":"2025-02-10"},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A recurring payment title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]).","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The URL to which the user will be redirected after authorization is completed.","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment/recurring":{"get":{"tags":["recurring-retail"],"summary":"Recurring Payment Status","description":"The \"Get Recurring Payment Status\" endpoint empowers users to inquire about the status of their recurring payments.\nUpon utilization of this endpoint, the system promptly retrieves and furnishes the current status of a specified recurring payment. \nThe returned payment statuses may vary depending on the bank, and the timing of status updates can also differ based on the bank's processing schedule.\nThis functionality provides users with real-time insights into the status of their recurring transactions.\n","operationId":"getRecurringPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/payment/recurring' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}/payment/recurring/cancel/initiate/{redirectUri}":{"get":{"tags":["recurring-retail"],"summary":"Start Cancel Payment Process","description":"The \"Cancel Recurring Payment\" endpoint allows users to cancel recurring payments. \nUpon calling this endpoint, a redirect URL is generated in response, directing the user to the bank's authorization page.\n\nOn the bank's page, users have the opportunity to verify the accuracy of the cancel payment request details required for the transfer cancellation and to confirm the operation. \nOnce the cancel payment request is approved by the user, they will be redirected to the previously defined page, and the cancellation status data will be transmitted via a callback.\n","operationId":"startCancelPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}/payment/recurring/cancel/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: ExAmPlEsTaTece1a4cb6-5e83-11ed-a320-856ce1faa777' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"","Payment amount. Format":"d+.d{2}","required":true,"schema":{"type":"string"},"example":0.99},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"PL12345678901234567890123456"},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"period","in":"header","description":"payment frequency","required":true,"schema":{"type":"string","enum":["WEEK","MONTH","YEAR"]},"example":"WEEK"},{"name":"startDate","in":"header","description":"Recurring payment start date","required":true,"schema":{"type":"string"},"example":"2024-02-10"},{"name":"endDate","in":"header","description":"Recurring payment end date","required":true,"schema":{"type":"string","format":"date-time"},"example":"2025-02-10"},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A recurring payment title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]).","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The URL to which the user will be redirected after authorization is completed.","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/{bankId}/payment/bundle/initiate/{redirectUri}":{"post":{"tags":["bundle-retail"],"summary":"Start Payment Process","description":"Returns a redirect url that directs to the bank’s authorization page","operationId":"startPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/{bankId}/payment/bundle/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'userId: 123' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The URL to which the user will be redirected after authorization is completed.","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundlePaymentsRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitRespBundle"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisBundleCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment/bundle":{"get":{"tags":["bundle-retail"],"summary":"Bundle Payment Status","description":"Return Bundle payment status","operationId":"getBundlePayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/payment/bundle' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}-company/initiate/{redirectUri}":{"get":{"tags":["ais-company"],"summary":"Start Linking Process","description":"The process of gaining access to the user's account begins with the generation of redirect URL to the bank's interface, \nwhere the user can grant consent for access to their account information. \nAfter successfully completing the bank's process the user will be redirected to the specified redirect URL,and a callback with the relevant data will be sent. Endpoint dedicated for company bank accounts.\n\nFor corporate accounts, certain banks require additional information.\n\n**Corporate Bank Accounts:**\n - For **PKO Bank** corporate accounts, the parameter `psuContextIdentifierValue` is required. The client must obtain this **psuContextIdentifierValue** from the PKO online banking platform.\n - For **Paribas and Credit Agricole** corporate accounts, the parameter `nip` is required. This represents the company's tax identification number (NIP).\n\n### **State Grouping for Extended Banking Transaction Access**\n\nThis feature allows **grouping of consents (states)** so that multiple states within the same group **can share tokens**, extending the time frame for fetching transactions beyond standard banking limits.\n\n### **Purpose**\n- Many banks impose strict time limits on transaction retrieval using a single consent (state).\n- For example, **PKO BP allows only up to 4 hours**, after which a new consent is required.\n- This solution will allow fetching transactions for at least **10 hours**, which for **PKO BP** would require three separate consents for the same account.\n\n### **How It Works**\n- **States will be grouped by the `userId` parameter**.\n- To belong to the same group, states must have the **same `userId`, `bank`, or client `apiKey`**.\n- If a **`userId` is not provided**, the state **will not be assigned to any group**.\n","operationId":"startLinking","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}-company/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'userId: 123' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n--header 'limitedScope: true' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"userId","in":"header","description":"The unique ID of the end user who agreed to provide access to the account information. ID generated on the client's side and passed to API FIZEN.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system.","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The address of the page to which the user will be redirected after completing the data sharing authorization process","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"limitedScope","in":"header","description":"Value informs whether access to the account will be limited to basic data.","required":true,"schema":{"type":"boolean"},"example":true},{"name":"psuContextIdentifierValue","in":"header","description":"**Required for corporate accounts at PKO Bank.** The psuContextIdentifierValue must be obtained from the PKO online banking platform.","required":false,"schema":{"type":"string"},"example":"PSU-123456789"},{"name":"nip","in":"header","description":"**Required for corporate accounts at Paribas and Credit Agricole.** The company's tax identification number (NIP).","required":false,"schema":{"type":"string"},"pattern":"\\d{10}","example":"1234567890"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/AisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/{bankId}-company/account/{accountId}":{"get":{"tags":["ais-company"],"summary":"Account Details","description":"This endpoint allows obtaining detailed information about the user's account for which they have previously granted consent, including information such as account owner, account number, account currency, available account balance, and account description. The data returned by our system depends on the information provided by each respective bank. As a result, the details of the response may vary between different banks. Users should account for potential differences in available data when integrating with our API. Endpoint dedicated for company bank accounts.\nFor corporate accounts, certain banks require additional information.\n**Corporate Bank Accounts:** - For **PKO Bank** corporate accounts, the parameter `psuContextIdentifierValue` is required. The client must obtain this **psuContextIdentifierValue** from the PKO online banking platform. - For **Paribas and Credit Agricole** corporate accounts, the parameter `nip` is required. This represents the company's tax identification number (NIP).","operationId":"getAccountDetails","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}-company/account/{accountId}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","required":true,"schema":{"type":"string"},"example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},{"name":"accountId","in":"path","description":"The bank account ID to which the end user has consented to provide access to the account information. One of the values necessary to query information about an account","required":true,"schema":{"type":"string"},"example":"VmhJQ0lKSHBKcEJ4TXByNHE2U3BKMG1SU3JXYStFVXBISDdCQUhLaHJXcz0="},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"psuContextIdentifierValue","in":"path","type":"string","description":"**Required for corporate accounts at PKO Bank.** The psuContextIdentifierValue must be obtained from the PKO online banking platform.","example":"PSU-123456789"},{"name":"nip","in":"header","type":"string","description":"**Required for corporate accounts at Paribas and Credit Agricole.** The company's tax identification number (NIP).","pattern":"\\d{10}","example":"1234567890"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDetailsResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}-company/account/{accountId}/transactions":{"get":{"tags":["ais-company"],"summary":"Account Transactions","description":"This endpoint enables access to the transaction history for a specific account number for which consent has been obtained previously.\nThe data returned by our system depends on the information provided by each respective bank. As a result, the details of the response may vary between different banks.\n\nIf certain transaction types cannot be retrieved due to an issue (e.g., database timeout, temporary service unavailability), \nthe response will still contain the successfully retrieved transactions and will also include a new field: \n**`transactionsStatusesFetchFailures`**, which lists the transaction types that **failed to be fetched**.\n\nIf **all** transaction types fail to be retrieved:\n- The **transactions list will be empty**.\n- The **`transactionsStatusesFetchFailures` field will include all requested transaction types**.\n\nExample Scenarios:\n- Only `DONE` transactions fail for **mBank**.\n- Two transaction types fail for **Pekao**.\n- All transaction types fail for **Erste**.\n\n## Exception Handling\nThere is one exception to this mechanism: \n**If the request exceeds the operation limit**, the system will return an explicit error response **without including the transactions list or the `transactionsStatusesFetchFailures` field**. \nIn this case, the client must retry the request after resolving the issue (e.g., reducing the number of transactions requested).\n\nUsers should account for potential differences in available data when integrating with our API.\nEndpoint dedicated for company bank accounts.\n","operationId":"getTransactions","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}-company/account/{accountId}/transactions' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","required":true,"schema":{"type":"string"},"example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},{"name":"tradeDateFrom","in":"header","description":"Start date from which data should be returned (inclusive). The date must be in the past\n(earlier than today; today's date is not allowed). Expected format is ISO 8601 date (YYYY-MM-DD).\n","required":false,"schema":{"type":"string"},"example":"2026-01-01"},{"name":"accountId","in":"path","description":"The bank account ID to which the end user has consented to provide access to the account information. One of the values necessary to query information about an account","required":true,"schema":{"type":"string"},"example":"VmhJQ0lKSHBKcEJ4TXByNHE2U3BKMG1SU3JXYStFVXBISDdCQUhLaHJXcz0="},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"includeAllTransactionStatuses","in":"header","description":"Optional flag controlling which transaction statuses are returned in the response.\n\nBy default (when the header is not provided or set to false), the API returns only\ntransactions with the following statuses: DONE, PENDING, HOLD.\nTransactions with statuses REJECTED, CANCELED, and SCHEDULED are excluded.\n\nWhen set to true, the API returns all available transaction statuses,\nincluding REJECTED, CANCELED, and SCHEDULED (if such transactions exist\nfor the given bank/account).\n","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionListResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError429"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}-company/KYC/{accountId}":{"get":{"tags":["ais-company"],"summary":"KYC","description":"This service provides a transparent way to access the user's identity by leveraging the granted consent for account access. It provides a field containing crucial information, such as the user's name and address, for precise user identification. Endpoint dedicated for company bank accounts.","operationId":"getKYCDetails","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}-company/KYC/{accountId}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","required":true,"schema":{"type":"string"},"example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},{"name":"accountId","in":"path","description":"The bank account ID to which the end user has consented to provide access to the account information. One of the values necessary to query information about an account","required":true,"schema":{"type":"string"},"example":"VmhJQ0lKSHBKcEJ4TXByNHE2U3BKMG1SU3JXYStFVXBISDdCQUhLaHJXcz0="},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycDetailsResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}-company/payment/initiate/{redirectUri}":{"get":{"tags":["domestic-company"],"summary":"Start Payment Process","description":"The payment initialization endpoint is a pivotal access point for businesses looking to initiate domestic payment processes seamlessly. \nIn response to this endpoint, a redirect URL is generated, guiding the business user to the bank's authorization page.\n\nOn the bank's authorization page, the business user gains the opportunity to meticulously verify the accuracy of the payment details necessary for the transfer and subsequently confirm the payment. \nOnce the user approves the payment, they are redirected to the previously defined page, and the transaction data is transmitted seamlessly via a callback.\n\nThis process ensures that businesses can securely and efficiently initiate and verify domestic payments, maintaining a robust and reliable payment initiation workflow for their corporate accounts.\n\nWhen making a payment, you have the option to perform a **split payment**. \n\nThe split payment mechanism is a payment system in which the amount of VAT, which is separated from the gross amount due to the seller, \nis transferred to a separate bank account, called a VAT account, to which the seller has limited access.\n\nTo successfully initiate a split payment, you **must provide all four parameters**: \n `spInvoiceNumber`, `spTaxIdentificationNumber`, `spTaxAmount`, `spDescription`. \n\nIf at least one of these parameters is provided but others are missing, the split payment request will be rejected.\n\nFor corporate accounts, certain banks require additional information.\n\n**Corporate Bank Accounts:**\n - For **PKO Bank** corporate accounts, the parameter `psuContextIdentifierValue` is required. The client must obtain this **psuContextIdentifierValue** from the PKO online banking platform.\n - For **Paribas and Credit Agricole** corporate accounts, the parameter `nip` is required. This represents the company's tax identification number (NIP).\n","operationId":"startPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}-company/payment/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'amount: 0.99' \\\n--header 'recipientAccountNumber: PL12345678901234567890123456' \\\n--header 'recipientNameAddress: Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz' \\\n--header 'userId: 123' \\\n--header 'title: FV/1234/22' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n--header 'spInvoiceNumber: INV001/2023/24' \\\n--header 'spTaxIdentificationNumber: 7242354073' \\\n--header 'spTaxAmount: 23.00' \\\n--header 'spDescription: VAT for January services'\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"","Payment amount. Format":"d+.d{2}","required":true,"schema":{"type":"string"},"example":0.99},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"}},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config. To handle Polish characters, URL encoding is necessary.","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"spInvoiceNumber","in":"header","description":"Payment Invoice Number (Required for split payment mechanism)","required":false,"schema":{"type":"string"},"example":"INV001/2023/24"},{"name":"spTaxIdentificationNumber","in":"header","description":"Tax Identification Number (NIP) (Required for split payment mechanism)","required":false,"schema":{"type":"string"},"example":3788796687},{"name":"spTaxAmount","in":"header","description":"Amount of VAT tax (Required for split payment mechanism)","required":false,"schema":{"type":"string"},"example":460},{"name":"spDescription","in":"header","description":"A brief description of the payment (Required for split payment mechanism)","required":false,"schema":{"type":"string"},"example":"VAT for January services"},{"name":"senderAccountNumber","in":"header","description":"Sender Account Number in IBAN format. Value required if Sender Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"}},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A transfer title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]). To handle Polish characters, URL encoding is necessary. For mBank, the use of the \":\" character in the title is not allowed.","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"redirectUri","in":"path","description":"The address of the page to which the user will be redirected after completing the data sharing authorization process","required":true,"schema":{"type":"string"},"example":"https://redirect-url.com"},{"name":"psuContextIdentifierValue","in":"header","description":"**Required for corporate accounts at PKO Bank.** The psuContextIdentifierValue must be obtained from the PKO online banking platform.","required":false,"schema":{"type":"string"},"example":"PSU-123456789"},{"name":"nip","in":"header","description":"**Required for corporate accounts at Paribas and Credit Agricole.** The company's tax identification number (NIP).","required":false,"schema":{"type":"string"},"pattern":"\\d{10}","example":"1234567890"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment (Get Domestic Payment Company)":{"get":{"tags":["domestic-company"],"summary":"Payment status","description":"The \"Get Payment Status\" endpoint empowers business account holders to seamlessly check the status of their payments. \nWhen this endpoint is invoked, the system promptly returns the current status of a specific payment, allowing business users to meticulously track the progress and history of their transactions.\n\nThis specialized functionality offers business account holders real-time access to the status of their payments, providing a level of transparency and visibility critical for managing financial transactions efficiently.\nBy leveraging this endpoint, businesses can ensure that they stay well-informed about the payment lifecycle, facilitating effective financial monitoring and decision-making within the context of their corporate accounts.\n\nThe returned payment statuses may vary depending on the bank, and the timing of status updates can also differ based on the bank's processing schedule.\n","operationId":"getPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/payment' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}-company/payment/recurring/initiate/{redirectUri}":{"get":{"tags":["recurring-company"],"summary":"Start Payment Process","description":"The \"Initiate Recurring Payment\" endpoint streamlines the initiation of recurring payment processes.Endpoint dedicated for company bank accounts.\nUpon calling this endpoint, a redirect URL is generated in response, directing the user to the bank's authorization page.\n\nOn the bank's page, users have the opportunity to verify the accuracy of the payment details required for the recurring transfer and to confirm the payment.\nOnce the payment is approved by the user, they will be redirected to the previously defined page, and the transaction data will be transmitted via a callback.\n\nFor corporate accounts, certain banks require additional information.\n\n**Corporate Bank Accounts:**\n - For **PKO Bank** corporate accounts, the parameter `psuContextIdentifierValue` is required. The client must obtain this **psuContextIdentifierValue** from the PKO online banking platform.\n - For **Paribas and Credit Agricole** corporate accounts, the parameter `nip` is required. This represents the company's tax identification number (NIP).\n","operationId":"startPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}-company/payment/recurring/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'amount: 0.99' \\\n--header 'recipientAccountNumber: PL12345678901234567890123456' \\ \n--header 'recipientNameAddress: Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz' \\ \n--header 'period: WEEK' \\\n--header 'startDate: 2024-02-10' \\\n--header 'endDate: 2025-02-10' \\\n--header 'userId: 123' \\\n--header 'title: FV/1234/22' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"","Payment amount. Format":"d+.d{2}","required":true,"schema":{"type":"string"},"example":0.99},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"PL12345678901234567890123456"},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"period","in":"header","description":"payment frequency","required":true,"schema":{"type":"string","enum":["WEEK","MONTH","YEAR"]},"example":"WEEK"},{"name":"startDate","in":"header","description":"Recurring payment start date","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-02-10"},{"name":"endDate","in":"header","description":"Recurring payment end date","required":true,"schema":{"type":"string","format":"date-time"},"example":"2025-02-10"},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A recurring payment title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]).","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The URL to which the user will be redirected after authorization is completed.","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"psuContextIdentifierValue","in":"header","description":"**Required for corporate accounts at PKO Bank.** The psuContextIdentifierValue must be obtained from the PKO online banking platform.","required":false,"schema":{"type":"string"},"example":"PSU-123456789"},{"name":"nip","in":"header","description":"**Required for corporate accounts at Paribas and Credit Agricole.** The company's tax identification number (NIP).","required":false,"schema":{"type":"string"},"pattern":"\\d{10}","example":"1234567890"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment/recurring (Get Company)":{"get":{"tags":["recurring-company"],"summary":"Recurring Payment Status","description":"The \"Get Recurring Payment Status\" endpoint empowers business users to efficiently inquire about the status of their recurring payments. \nUpon utilizing this endpoint, the system promptly retrieves and furnishes the current status of a specified recurring payment, providing business users with real-time insights into the status of their recurring transactions.\nThe returned payment statuses may vary depending on the bank, and the timing of status updates can also differ based on the bank's processing schedule.\nThis functionality is particularly valuable for companies managing recurring financial commitments, allowing them to stay informed and in control of their ongoing transactions.\nThe seamless access to real-time recurring payment status enhances financial transparency and supports effective decision-making within the corporate context.\n","operationId":"getRecurringPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/payment/recurring' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}-company/payment/recurring/cancel/initiate/{redirectUri}":{"get":{"tags":["recurring-company"],"summary":"Start Cancel Payment Process","description":"The \"Cancel Recurring Payment\" endpoint allows users to cancel recurring payments. \nUpon calling this endpoint, a redirect URL is generated in response, directing the user to the bank's authorization page.\n\nOn the bank's page, users have the opportunity to verify the accuracy of the cancel payment request details required for the transfer cancellation and to confirm the operation. \nOnce the cancel payment request is approved by the user, they will be redirected to the previously defined page, and the cancellation status data will be transmitted via a callback.\n","operationId":"startCancelPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/{bankId}-company/payment/recurring/cancel/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: ExAmPlEsTaTece1a4cb6-5e83-11ed-a320-856ce1faa777' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"","Payment amount. Format":"d+.d{2}","required":true,"schema":{"type":"string"},"example":0.99},{"name":"recipientAccountNumber","in":"header","description":"Recipient Account Number in IBAN format. Value required if Recipient Account Number is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"PL12345678901234567890123456"},{"name":"recipientNameAddress","in":"header","description":"Recipient Name & Address. Value required if Recipient Name Address is not set up by Fizen config","required":false,"schema":{"type":"string"},"example":"Jan Kowalski ul. Zbiorcza 2 m45 90-300 Lodz"},{"name":"period","in":"header","description":"payment frequency","required":true,"schema":{"type":"string","enum":["WEEK","MONTH","YEAR"]},"example":"WEEK"},{"name":"startDate","in":"header","description":"Recurring payment start date. The date must be in the future (later than the current date).\nExpected format is ISO 8601 date (YYYY-MM-DD).\n","required":true,"schema":{"type":"string"},"example":"2024-02-10"},{"name":"endDate","in":"header","description":"Recurring payment end date. Expected format is ISO 8601 date (YYYY-MM-DD).","required":true,"schema":{"type":"string","format":"date-time"},"example":"2025-02-10"},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"A recurring payment title generated by the client and passed to the Fizen API. The title must contain between 5 and 80 characters ([a-zA-Z0-9\\\\_\\\\-\\\\s\\\\.\\\\:\\/]). For mBank, the use of the \":\" character in the title is not allowed.","required":false,"schema":{"type":"string"},"example":"FV/1234/22"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"redirectUri","in":"path","description":"The URL to which the user will be redirected after authorization is completed.","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/{bankId}-company/payment/sepa/initiate/{redirectUri}":{"get":{"tags":["sepa-company"],"summary":"SEPA Payment Initiation","description":"The \"SEPA Payment Initiation\" endpoint enables business account holders to seamlessly initiate SEPA payments within the Single Euro Payments Area (SEPA). \nThis endpoint functions similarly to domestic payments but is specifically designed for cross-border transactions in **EUR**.\n\nWhen this endpoint is invoked, the system processes the payment request and returns a confirmation of the initiation, allowing business users to track the progress of their SEPA transactions efficiently.\n\nThis functionality ensures that businesses can securely execute SEPA transactions while maintaining real-time transparency over payment processing, helping them optimize international financial operations.\n\nFor corporate accounts, certain banks require additional information.\n\n **Corporate Bank Accounts:**\n - For **PKO Bank** corporate accounts, the parameter `psuContextIdentifierValue` is required. The client must obtain this **psuContextIdentifierValue** from the PKO online banking platform.\n - For **Paribas and Credit Agricole** corporate accounts, the parameter `nip` is required. This represents the company's tax identification number (NIP).\n","operationId":"startSepaPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/mbank/payment/sepa/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'Content-Type: application/json' \\\n--header 'recipientAccountNumber: DE89370400440532013000' \\\n--header 'recipientNameAddress: John Doe Hauptstrasse 10 10115 Berlin' \\\n--header 'currency: EUR' \\\n--header 'recipientCountryCode: DEU' \\\n--header 'userId: 123' \\\n--header 'title: FV/1234/22' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0'\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"amount","in":"header","description":"Payment amount in EUR (format: d+.d{2})\n","required":true,"schema":{"type":"string"},"example":"1000.00"},{"name":"currency","in":"header","description":"Currency for SEPA payments (always EUR)","required":true,"schema":{"type":"string","enum":["EUR"]},"example":"EUR"},{"name":"recipientAccountNumber","in":"header","description":"Recipient's IBAN (International Bank Account Number)","required":true,"schema":{"type":"string"},"example":"DE89370400440532013000"},{"name":"recipientNameAddress","in":"header","description":"Recipient's full name and address","required":true,"schema":{"type":"string"},"example":"John Doe, 123 Berlin Street, 10117 Berlin"},{"name":"recipientCountryCode","in":"header","description":"ISO 3166-1 alpha-3 country code of the recipient’s bank","required":true,"schema":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"example":"DEU"},{"name":"senderAccountNumber","in":"header","description":"Sender's IBAN, required if not pre-configured in Fizen","required":false,"schema":{"type":"string"},"example":"FR7630006000011234567890189"},{"name":"userId","in":"header","description":"Unique user identifier, generated on the client's side","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"title","in":"header","description":"Transfer title (5-80 characters). For mBank, the use of \":\" is not allowed","required":false,"schema":{"type":"string"},"example":"SEPA Payment Invoice 1234/24"},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"Browser agent identifying the end user's browser and OS","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"bankId","in":"path","description":"Bank identifier for authorization of SEPA payment","required":true,"schema":{"type":"string"},"example":"alior"},{"name":"redirectUri","in":"path","description":"Redirect URL where the user will be sent after authorization","required":true,"schema":{"type":"string"},"example":"https://redirect-url.com"},{"name":"psuContextIdentifierValue","in":"header","description":"**Required for corporate accounts at PKO Bank.** The psuContextIdentifierValue must be obtained from the PKO online banking platform.","required":false,"schema":{"type":"string"},"example":"PSU-123456789"},{"name":"nip","in":"header","description":"**Required for corporate accounts at Paribas and Credit Agricole.** The company's tax identification number (NIP).","required":false,"schema":{"type":"string"},"pattern":"\\d{10}","example":"1234567890"}],"responses":{"200":{"description":"OK - SEPA Payment Initiated Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request - Invalid Input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found - Invalid Endpoint or Missing Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment (Get Sepa Payment Company)":{"get":{"tags":["sepa-company"],"summary":"SEPA Payment Status","description":"The \"Get SEPA Payment Status\" endpoint allows business account holders to seamlessly check the status of their SEPA payments within the Single Euro Payments Area (SEPA). \nWhen this endpoint is invoked, the system promptly returns the current status of a specific SEPA payment, enabling business users to track their international transactions efficiently.\n\n### Key Features:\n- **Real-Time Tracking**: Businesses receive up-to-date payment statuses, ensuring they remain informed about their transactions.\n- **Cross-Border SEPA Monitoring**: Unlike domestic payments, SEPA transactions involve additional processing layers and may experience variations in update frequency based on the involved banks.\n\nThe returned SEPA payment statuses may vary depending on the recipient's bank and country, and the timing of updates may differ due to international banking regulations and cut-off times.\n","operationId":"getSepaPaymentStatus","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/mbank/payment/sepa/status' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK - SEPA Payment Status Retrieved Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitResp"}}}},"400":{"description":"Bad Request - Invalid Input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found - Payment Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/{bankId}-company/payment/bundle/initiate/{redirectUri}":{"post":{"tags":["bundle-company"],"summary":"Start Payment Process","description":"Returns a redirect url that directs to the bank’s authorization page","operationId":"startPayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/{bankId}/payment/bundle/initiate/{redirectUri}' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'userId: 123' \\\n--header 'ip: 11.11.00.00' \\\n--header 'agent: My Agent 1.0' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"userId","in":"header","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","required":false,"schema":{"type":"string"},"example":432532453425},{"name":"ip","in":"header","description":"End user IP address","required":false,"schema":{"type":"string"},"example":"10.10.54.1"},{"name":"agent","in":"header","description":"A browser agent that identifies the end user browser and operating system","required":false,"schema":{"type":"string"},"example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.96 Safari/537.36"},{"name":"nip","in":"header","type":"string","description":"The company's tax identification number (NIP).","required":true,"pattern":"\\d{10}","example":"1234567890"},{"name":"redirectUri","in":"path","description":"The URL to which the user will be redirected after authorization is completed.","required":true,"schema":{"type":"string"},"example":"https%3A%2F%2redirectUri.com"},{"name":"bankId","in":"path","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","required":true,"schema":{"type":"string"},"example":"alior"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundlePaymentsRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitRespBundle"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"callbacks":{"result":{"$ref":"#/components/callbacks/PisBundleCallback"},"errorResult":{"$ref":"#/components/callbacks/ErrorCallback"}}}},"/payment/bundle (Get Company":{"get":{"tags":["bundle-company"],"summary":"Bundle Payment Status","description":"Return Bundle payment status","operationId":"getBundlePayment","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n--url 'https://api.sandbox.fizen.com/payment/bundle' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'state: d2b75e70-c135-11ed-9018-4510c14d98vc' \\\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="},{"name":"state","in":"header","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to initiate payment","required":true,"schema":{"type":"string"},"example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV80M2E3"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError404"}}}},"430":{"description":"Request Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError430"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/fizenPay/createTransaction":{"post":{"tags":["fizen-pay-start"],"summary":"Generate Domestic Transaction","description":"This endpoint allows to init payment process via Fizen Pay service.\nInitiating the payment process, it is necessary to provide some key information about the payment as well as information for subsequent payment processing like userId, callback address. \nYou must also specify recipient data like **recipientName, recipientAddress, recipientAccountNumber.**\n\nOnly one expiration parameter can be used: either **days or minutes**. Providing both at the same time is not allowed.\n \nFor corporate accounts, certain banks require additional information.\n\n**Corporate Bank Accounts:**\n- For **Paribas and Credit Agricole** corporate accounts, the parameter `nip` is required. This represents the company's tax identification number (NIP).\n","operationId":"generateTransactionFizenPay","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transferTitle","amount","userId","callbackSuccess","callbackFailure"],"properties":{"transferTitle":{"type":"string","description":"A unique identifier or reference for the transfer, such as an order number.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,70}"},"amount":{"type":"string","description":"The amount to be transferred, formatted as a string (e.g., \"420.69\").","pattern":"\\d+\\.\\d{2}"},"userId":{"type":"string","description":"The unique identifier associated with the user initiating the transfer (e.g., \"USER_69420\").","pattern":"([a-zA-Z0-9\\_\\-\\s\\.\\:\\/]){5,200}"},"callbackSuccess":{"type":"string","description":"The callback URL for a successful transaction.","pattern":"https\\:\\/\\/.*"},"callbackFailure":{"type":"string","description":"The callback URL for a failed transaction.","pattern":"https\\:\\/\\/.*"},"recipientName":{"type":"string","description":"The name of the recipient.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,70}"},"recipientAddress":{"type":"string","description":"The address of the recipient.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,69}"},"recipientAccountNumber":{"type":"string","description":"The account number of the recipient.","pattern":"[A-Z]{2}\\d{26}"},"nip":{"type":"string","description":"**Required for corporate accounts at Paribas and Credit Agricole.** The company's tax identification number (NIP).","pattern":"\\d{10}","example":"1234567890"},"linkExpirationDays":{"type":"integer","description":"The number of days the link remains valid, after which the link expires.","minimum":1,"maximum":7,"example":3},"linkExpirationMinutes":{"type":"integer","description":"The number of minutes the link remains valid, after which the link expires.","minimum":5,"maximum":1440,"example":25}}}}}},"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/fizenPay/createTransaction' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"transferTitle\": \"Order 69420...+++\",\n \"amount\": \"420.69\",\n \"userId\": \"USER_69420\",\n \"callbackSuccess\": \"https://fizen.com/ok\",\n \"callbackFailure\": \"https://fizen.com/error\"\n }'\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","description":"Link to payment","example":"https://sandbox.fizen.com/secure.fizenpay?transactionId=a91a47b4"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError401"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/fizenPay/createRecurring":{"post":{"tags":["fizen-pay-start"],"summary":"Generate Recurring Transaction","description":"This endpoint allows to init recurring payment process via Fizen Pay service.\nInitiating the recurring payment process, it is necessary to provide some key information about the payment as well as information for subsequent payment processing like userId, callback address,\nYou must also specify recipient data like **recipientName, recipientAddress, recipientAccountNumber.**\n\nOnly one expiration parameter can be used: either **days or minutes**. Providing both at the same time is not allowed.\n\nFor corporate accounts, certain banks require additional information.\n\n**Corporate Bank Accounts:**\n - For **Paribas and Credit Agricole** corporate accounts, the parameter `nip` is required. This represents the company's tax identification number (NIP).\n","operationId":"generateRecurringFizenPay","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transferTitle","amount","period","startDate","endDate","userId","callbackSuccess","callbackFailure"],"properties":{"transferTitle":{"type":"string","description":"A unique identifier or reference for the transfer, such as an order number.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,70}"},"amount":{"type":"string","description":"The amount to be transferred, formatted as a string (e.g., \"42.59\").","pattern":"\\d+\\.\\d{2}"},"period":{"type":"string","enum":["DAY","YEAR","MONTH","WEEK"],"description":"The payment frequency, formatted as an enum (\"DAY\", \"YEAR\",\"MONTH\", \"WEEK\"). **mBank, Pekao, Paribas** are not available for DAY frequencies.","pattern":"MONTH"},"startDate":{"type":"string","description":"A date the recurring payment start, formatted as a string (e.g., \"2024-10-10\").","pattern":"\\d+\\.\\d{2}"},"endDate":{"type":"string","format":"date-time","description":"A date the recurring payment end, formatted as a string (e.g., \"2025-10-10\").","pattern":"\\d+\\.\\d{2}"},"userId":{"type":"string","description":"The unique identifier associated with the user initiating the transfer (e.g., \"USER_69420\").","pattern":"([a-zA-Z0-9\\_\\-\\s\\.\\:\\/]){5,200}"},"callbackSuccess":{"type":"string","description":"The callback URL for a successful transaction.","pattern":"https\\:\\/\\/.*"},"callbackFailure":{"type":"string","description":"The callback URL for a failed transaction.","pattern":"https\\:\\/\\/.*"},"recipientName":{"type":"string","description":"The name of the recipient.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,70}"},"recipientAddress":{"type":"string","description":"The address of the recipient.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,69}"},"recipientAccountNumber":{"type":"string","description":"The account number of the recipient.","pattern":"[A-Z]{2}\\d{26}"},"linkExpirationDays":{"type":"integer","description":"The number of days the link remains valid, after which the link expires.","minimum":1,"maximum":7,"example":3},"linkExpirationMinutes":{"type":"integer","description":"The number of minutes the link remains valid, after which the link expires.","minimum":5,"maximum":1440,"example":25},"nip":{"type":"string","description":"**Required for corporate accounts at Paribas and Credit Agricole.** The company's tax identification number (NIP).","pattern":"\\d{10}","example":"1234567890"}}}}}},"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/fizenPay/createRecurring' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"transferTitle\": \"Order 69420...+++\",\n \"amount\": \"420.69\",\n \"period\": \"MONTH\",\n \"startDate\": \"2024-10-10\",\n \"endDate\": \"2025-10-10\",\n \"userId\": \"USER_69420\",\n \"callbackSuccess\": \"https://fizen.com/ok\",\n \"callbackFailure\": \"https://fizen.com/error\"\n }'\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","description":"Link to fizenPay payment gateway","example":"https://sandbox.fizen.com/secure.fizenrecurring?transactionId=a91a47b4"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError401"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/fizenPay/createExpress":{"post":{"tags":["fizen-pay-start"],"summary":"Generate Express Domestic Transaction","description":"This endpoint allows to init express payment process via Fizen Pay service.\nInitiating the payment process, it is necessary to provide some key information about the payment as well as information for subsequent payment processing like userId, callback address.\nYou must also specify recipient data like **recipientName, recipientAddress, recipientAccountNumber.**\n\nOnly one expiration parameter can be used: either **days or minutes**. Providing both at the same time is not allowed.\n","operationId":"generateExpressTransactionFizenPay","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transferTitle","amount","userId","callbackSuccess","callbackFailure"],"properties":{"transferTitle":{"type":"string","description":"A unique identifier or reference for the transfer, such as an order number.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,70}"},"amount":{"type":"string","description":"The amount to be transferred, formatted as a string (e.g., \"420.69\").","pattern":"\\d+\\.\\d{2}"},"userId":{"type":"string","description":"The unique identifier associated with the user initiating the transfer (e.g., \"USER_69420\").","pattern":"([a-zA-Z0-9\\_\\-\\s\\.\\:\\/]){5,200}"},"callbackSuccess":{"type":"string","description":"The callback URL for a successful transaction.","pattern":"https\\:\\/\\/.*"},"callbackFailure":{"type":"string","description":"The callback URL for a failed transaction.","pattern":"https\\:\\/\\/.*"},"recipientName":{"type":"string","description":"The name of the recipient.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,70}"},"recipientAddress":{"type":"string","description":"The address of the recipient.","pattern":"([a-zA-Z0-9ęóąśłżźćńĘÓĄŚŁŻŹĆŃ\\_\\-\\s\\.\\,\\:\\/]){3,69}"},"recipientAccountNumber":{"type":"string","description":"The account number of the recipient.","pattern":"[A-Z]{2}\\d{26}"},"linkExpirationDays":{"type":"integer","description":"The number of days the link remains valid, after which the link expires.","minimum":1,"maximum":7,"example":3},"linkExpirationMinutes":{"type":"integer","description":"The number of minutes the link remains valid, after which the link expires.","minimum":5,"maximum":1440,"example":25}}}}}},"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n--url 'https://api.sandbox.fizen.com/fizenPay/createExpress' \\\n--header 'apiKey: 9693455a2698ff0316f14da3c30a18c97a4d0000' \\\n--header 'token: ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961==' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"transferTitle\": \"Order 69420...+++\",\n \"amount\": \"420.69\",\n \"userId\": \"USER_69420\",\n \"callbackSuccess\": \"https://fizen.com/ok\",\n \"callbackFailure\": \"https://fizen.com/error\"\n }'\n"}],"parameters":[{"name":"apiKey","in":"header","description":"Individual API key assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"9693455a2698ff0316f14da3c30a18c97a4d0000"},{"name":"token","in":"header","description":"Individual token assigned by FIZEN enabling connection with FIZEN API","required":true,"schema":{"type":"string"},"example":"ZzFkMDd4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc961=="}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","description":"Link to payment","example":"https://sandbox.fizen.com/secure.fizenexpress?transactionId=a91a47b4"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError401"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}}}},"/fizenPay/invalidateTransaction/{transactionId}":{"delete":{"tags":["fizen-pay-start"],"summary":"Invalidate Transaction","description":"This endpoint allows to invalidates Fizen Pay payment process.\nInvalidates (cancels) an existing Fizen Pay transaction identified by `transactionId`.\nFor an already invalidated transaction endpoint will return success.\n","operationId":"invalidateTransactionFizenPay","parameters":[{"name":"transactionId","in":"path","required":true,"description":"Unique identifier of the transaction to invalidate.","schema":{"type":"string","pattern":"^[0-9a-fA-F\\-]{36}$","example":"f86ced6e-9abd-11f0-a376-0b874019f2aa"}},{"name":"apiKey","in":"header","required":true,"description":"The API key assigned to the client.","schema":{"type":"string","example":"8693485c2698ff0316f14da3c30a18c97a4d0681"}},{"name":"token","in":"header","required":true,"description":"Session/authorization token for the user.","schema":{"type":"string","example":"YzFkMDk4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc3NQ=="}}],"responses":{"200":{"description":"No Content – the transaction was invalidated and no body is returned."},"400":{"description":"Bad Request – invalid `transactionId` or missing required headers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized – invalid or missing `apiKey`/`token`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError401"}}}},"404":{"description":"Not Found – the transaction with the given `transactionId` does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError500"}}}}},"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --location --request DELETE 'https://api.sandbox.fizen.com/fizenPay/invalidateTransaction/f86ced6e-9abd-11f0-a376-0b874019f2aa' \\\n--header 'apiKey: 8693485c2698ff0316f14da3c30a18c97a4d0681' \\\n--header 'token: YzFkMDk4ZTM5MDUxMjI0ZTdmZjhjZTFkZjIxZGZiMWQ0OTZlYzc3NQ=='\n"}]}},"/fizen-analytics/all-transactions/summary":{"get":{"tags":["analytics"],"summary":"Get all transactions summary","description":"Returns a summary of all transactions for the selected month or, when the optional day header is provided, for the selected day. The response includes daily SCA and non-SCA statistics. The transaction list may contain domestic, recurring, and bundle transactions, each with its own set of fields.","operationId":"GetAllTransactionsSummary","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --location 'https://api.sandbox.fizen.com/fizen-analytics/all-transactions/summary' \\\n--header 'apiKey: 869dadasf332f14da3c30sa2323fqw0681' \\\n--header 'token: token343fdsdfs' \\\n--header 'year: 2026' \\\n--header 'month: 4' \\\n--header 'day: 15' \\\n--header 'client-name: example-client'\n"}],"parameters":[{"name":"apiKey","in":"header","required":true,"schema":{"type":"string","example":"869dadasf332f14da3csasafgaew23fqw0681"},"description":"API key assigned to the client"},{"name":"token","in":"header","required":true,"schema":{"type":"string","example":"869dadasf332f14da3csasafgaew23fqw0681"},"description":"Authorization token assigned to the client"},{"name":"year","in":"header","required":true,"schema":{"type":"integer","example":2026},"description":"Year for which the transaction summary should be returned"},{"name":"month","in":"header","required":true,"schema":{"type":"integer","minimum":1,"maximum":12,"example":4},"description":"Month for which the transaction summary should be returned"},{"name":"day","in":"header","required":false,"schema":{"type":"integer","minimum":1,"maximum":31,"example":15},"description":"Optional day of the month for which the transaction summary should be returned. When omitted, the summary covers the entire selected month"},{"name":"client-name","in":"header","required":true,"schema":{"type":"string","example":"example-client"},"description":"Name of the client for which we want to retrieve statistics"}],"responses":{"200":{"description":"All transactions summary returned successfully","content":{"application/json":{"schema":{"type":"object","required":["transactionList","everydayStats","totalNumberOfTransactions","totalAmount","totalNumberOfRecurringTransactions","totalRecurringAmount","totalNumberOfBundleTransactions","totalBundleAmount"],"properties":{"transactionList":{"type":"array","description":"List of transactions for the selected month or day. The list may contain domestic, recurring, and bundle transactions.","items":{"oneOf":[{"type":"object","description":"Domestic transaction","properties":{"stateId":{"type":"string","example":"c85d94f3-3f47-11f1-922f-ff0a63ec939e"},"amount":{"type":"string","example":"0.99"},"currency":{"type":"string","example":"PLN"},"senderAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"senderBank":{"type":"string","example":"fizenbank"},"recipientNameAddress":{"type":"string","example":"addressss"},"recipientAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"paymentStatus":{"type":"string","example":"DONE"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-04-23"},"executionDate":{"type":"string","format":"date","example":"2026-04-23"},"operationType":{"type":"string","example":"DOMESTIC"},"userId":{"type":"string","example":"Domestic"},"transferTitle":{"type":"string","example":"Order c85d94f3-3f47-11f1-922f-ff0a63ec939e"},"isSCA":{"type":"boolean","example":true}}},{"type":"object","description":"Recurring transaction","properties":{"stateId":{"type":"string","example":"b63af141-3f47-11f1-922f-2d9fc527509a"},"amount":{"type":"string","example":"0.01"},"currency":{"type":"string","example":"PLN"},"senderAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"senderBank":{"type":"string","example":"fizenbank"},"recipientNameAddress":{"type":"string","example":"dsdfsdfdsfdsf"},"recipientAccountNumber":{"type":"string","example":"PL12341234123412341234"},"paymentStatus":{"type":"string","example":"IN_PROGRESS"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-04-23"},"executionDate":{"type":"string","format":"date","example":"2026-04-23"},"operationType":{"type":"string","example":"RECURRING"},"userId":{"type":"string","example":"Fizen"},"transferTitle":{"type":"string","example":"Order b63af141-3f47-11f1-922f-2d9fc527509a"},"isSCA":{"type":"boolean","example":true},"lastExecutionDate":{"type":"string","format":"date","example":"2027-09-17"},"period":{"type":"string","example":"MONTH"},"numberOfTransactionsInMonth":{"type":"integer","example":1},"amountOfTransactionsInMonth":{"type":"string","example":"0.01"},"cancelled":{"type":"boolean","example":false}}},{"type":"object","description":"Bundle transaction","properties":{"stateId":{"type":"string","example":"33a0cc9a-3f47-11f1-922f-a9744f062a21"},"amount":{"type":"string","example":"0.46"},"currency":{"type":"string","example":"PLN"},"senderAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"senderBank":{"type":"string","example":"fizenbank"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-04-23"},"executionDate":{"type":"string","format":"date","example":"2026-04-23"},"operationType":{"type":"string","example":"BUNDLE"},"userId":{"type":"string","example":"Fizen"},"isSCA":{"type":"boolean","example":true},"bundleId":{"type":"array","description":"Identifiers of payments belonging to the bundle","items":{"type":"string","example":"uuid0"},"example":["uuid0","uuid1"]},"paymentsInBundle":{"type":"integer","example":2},"paymentIndexInBundle":{"type":"integer","example":1},"bundleAmount":{"type":"string","example":"0.92"},"numberOfTransactionsInMonth":{"type":"integer","example":1},"amountOfTransactionsInMonth":{"type":"string","example":"0.46"}}}]}},"everydayStats":{"type":"object","description":"Daily SCA and non-SCA statistics keyed by date","additionalProperties":{"type":"object","properties":{"scaNumber":{"type":"integer","example":4},"scaAmount":{"type":"string","example":"1.92"},"nonScaNumber":{"type":"integer","example":0},"nonScaAmount":{"type":"string","example":"0.00"}}},"example":{"2026-04-23":{"scaNumber":4,"scaAmount":"1.92","nonScaNumber":0,"nonScaAmount":"0.00"}}},"totalNumberOfTransactions":{"type":"integer","example":4},"totalAmount":{"type":"string","example":"1.92"},"totalNumberOfRecurringTransactions":{"type":"integer","example":1},"totalRecurringAmount":{"type":"string","example":"0.01"},"totalNumberOfBundleTransactions":{"type":"integer","example":2},"totalBundleAmount":{"type":"string","example":"0.92"}}},"example":{"transactionList":[{"stateId":"c85d94f3-3f47-11f1-922f-ff0a63ec939e","amount":"0.99","currency":"PLN","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","recipientNameAddress":"addressss","recipientAccountNumber":"PL18109024023536889671897127","paymentStatus":"DONE","initType":"Integracja API","initDate":"2026-04-23","executionDate":"2026-04-23","operationType":"DOMESTIC","userId":"Domestic","transferTitle":"Order c85d94f3-3f47-11f1-922f-ff0a63ec939e","isSCA":true},{"stateId":"b63af141-3f47-11f1-922f-2d9fc527509a","amount":"0.01","currency":"PLN","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","recipientNameAddress":"dsdfsdfdsfdsf","recipientAccountNumber":"PL12341234123412341234","paymentStatus":"IN_PROGRESS","initType":"Integracja API","initDate":"2026-04-23","executionDate":"2026-04-23","operationType":"RECURRING","userId":"Fizen","transferTitle":"Order b63af141-3f47-11f1-922f-2d9fc527509a","isSCA":true,"lastExecutionDate":"2027-09-17","period":"MONTH","numberOfTransactionsInMonth":1,"amountOfTransactionsInMonth":"0.01","cancelled":false},{"stateId":"33a0cc9a-3f47-11f1-922f-a9744f062a21","amount":"0.46","currency":"PLN","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","initType":"Integracja API","initDate":"2026-04-23","executionDate":"2026-04-23","operationType":"BUNDLE","userId":"Fizen","isSCA":true,"bundleId":["uuid0","uuid1"],"paymentsInBundle":2,"paymentIndexInBundle":1,"bundleAmount":"0.92","numberOfTransactionsInMonth":1,"amountOfTransactionsInMonth":"0.46"},{"stateId":"1056ae33-3f47-11f1-922f-c7868c52dccc","amount":"0.46","currency":"PLN","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","initType":"Integracja API","initDate":"2026-04-23","executionDate":"2026-04-23","operationType":"BUNDLE","userId":"Fizen","isSCA":true,"bundleId":["uuid0","uuid1"],"paymentsInBundle":2,"paymentIndexInBundle":2,"bundleAmount":"0.92","numberOfTransactionsInMonth":1,"amountOfTransactionsInMonth":"0.46"}],"everydayStats":{"2026-04-23":{"scaNumber":4,"scaAmount":"1.92","nonScaNumber":0,"nonScaAmount":"0.00"}},"totalNumberOfTransactions":4,"totalAmount":"1.92","totalNumberOfRecurringTransactions":1,"totalRecurringAmount":"0.01","totalNumberOfBundleTransactions":2,"totalBundleAmount":"0.92"}}}},"400":{"description":"Bad Request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/fizen-analytics/recurring-transactions/summary":{"get":{"tags":["analytics"],"summary":"Get recurring transactions summary","description":"Returns a summary of recurring transactions for the selected month or, when the optional day header is provided, for the selected day. The response includes daily SCA and non-SCA statistics.","operationId":"GetRecurringTransactionsSummary","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --location 'https://api.sandbox.fizen.com/fizen-analytics/recurring-transactions/summary' \\\n--header 'apiKey: 869dadasf332f14da3c30sa2323fqw0681' \\\n--header 'token: asdd485c2698ff0316f14da3c678997c97a4d0681' \\\n--header 'year: 2026' \\\n--header 'month: 4' \\\n--header 'day: 15' \\\n--header 'client-name: example-client'\n"}],"parameters":[{"name":"apiKey","in":"header","required":true,"schema":{"type":"string","example":"869dadasf332f14da3csasafgaew23fqw0681"},"description":"API key assigned to the client"},{"name":"token","in":"header","required":true,"schema":{"type":"string","example":"869dadasf332f14da3csasafgaew23fqw0681"},"description":"Authorization token assigned to the client"},{"name":"year","in":"header","required":true,"schema":{"type":"integer","example":2026},"description":"Year for which the recurring transaction summary should be returned"},{"name":"month","in":"header","required":true,"schema":{"type":"integer","minimum":1,"maximum":12,"example":4},"description":"Month for which the recurring transaction summary should be returned"},{"name":"day","in":"header","required":false,"schema":{"type":"integer","minimum":1,"maximum":31,"example":15},"description":"Optional day of the month for which the recurring transaction summary should be returned. When omitted, the summary covers the entire selected month"},{"name":"client-name","in":"header","required":true,"schema":{"type":"string","example":"example-client"},"description":"Name of the client for which we want to retrieve statistics"}],"responses":{"200":{"description":"Recurring transactions summary returned successfully","content":{"application/json":{"schema":{"type":"object","required":["transactionList","everydayStats","totalNumberOfTransactions","totalAmount"],"properties":{"transactionList":{"type":"array","description":"List of recurring transactions for the selected month or day","items":{"type":"object","properties":{"stateId":{"type":"string","example":"601b8f60-3ea9-11f1-b42d-5d9ac88d034b"},"amount":{"type":"string","example":"0.01"},"currency":{"type":"string","example":"PLN"},"senderAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"senderBank":{"type":"string","example":"fizenbank"},"recipientNameAddress":{"type":"string","example":"dsdfsdfdsfdsf"},"recipientAccountNumber":{"type":"string","example":"PL12341234123412341234"},"paymentStatus":{"type":"string","example":"RECURRING_PLANNED"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-04-23"},"executionDate":{"type":"string","format":"date","example":"2026-04-23"},"operationType":{"type":"string","example":"RECURRING"},"userId":{"type":"string","example":"Fizen"},"transferTitle":{"type":"string","example":"Order 601b8f60-3ea9-11f1-b42d-5d9ac88d034b"},"lastExecutionDate":{"type":"string","format":"date","example":"2027-09-17"},"period":{"type":"string","example":"MONTH"},"numberOfTransactionsInMonth":{"type":"integer","example":1},"amountOfTransactionsInMonth":{"type":"string","example":"0.01"},"cancelled":{"type":"boolean","example":false}}}},"everydayStats":{"type":"object","description":"Daily SCA and non-SCA statistics keyed by date","additionalProperties":{"type":"object","properties":{"scaNumber":{"type":"integer","example":1},"scaAmount":{"type":"string","example":"0.01"},"nonScaNumber":{"type":"integer","example":0},"nonScaAmount":{"type":"string","example":"0.00"}}},"example":{"2026-04-23":{"scaNumber":1,"scaAmount":"0.01","nonScaNumber":0,"nonScaAmount":"0.00"}}},"totalNumberOfTransactions":{"type":"integer","example":1},"totalAmount":{"type":"string","example":"0.01"}}},"example":{"transactionList":[{"stateId":"601b8f60-3ea9-11f1-b42d-5d9ac88d034b","amount":"0.01","currency":"PLN","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","recipientNameAddress":"dsdfsdfdsfdsf","recipientAccountNumber":"PL12341234123412341234","paymentStatus":"RECURRING_PLANNED","initType":"Integracja API","initDate":"2026-04-23","executionDate":"2026-04-23","operationType":"RECURRING","userId":"Fizen","transferTitle":"Order 601b8f60-3ea9-11f1-b42d-5d9ac88d034b","lastExecutionDate":"2027-09-17","period":"MONTH","numberOfTransactionsInMonth":1,"amountOfTransactionsInMonth":"0.01","cancelled":false}],"everydayStats":{"2026-04-23":{"scaNumber":1,"scaAmount":"0.01","nonScaNumber":0,"nonScaAmount":"0.00"}},"totalNumberOfTransactions":1,"totalAmount":"0.01"}}}},"400":{"description":"Bad Request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/fizen-analytics/bundle-transactions/summary":{"get":{"tags":["analytics"],"summary":"Get bundle transactions summary","description":"Returns a summary of bundle transactions for the selected month or, when the optional day header is provided, for the selected day. The response includes daily SCA and non-SCA statistics.","operationId":"GetBundleTransactionsSummary","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --location 'https://api.sandbox.fizen.com/fizen-analytics/bundle-transactions/summary' \\\n--header 'apiKey: 869dadasf332f14da3csasafgaew23fqw0681' \\\n--header 'token: asdd485c2698ff0316f14da3c678997c97a4d0681' \\\n--header 'year: 2026' \\\n--header 'month: 4' \\\n--header 'day: 15' \\\n--header 'client-name: example-client'\n"}],"parameters":[{"name":"apiKey","in":"header","required":true,"schema":{"type":"string","example":"869dadasf332f14da3csasafgaew23fqw0681"},"description":"API key assigned to the client"},{"name":"token","in":"header","required":true,"schema":{"type":"string","example":"869dadasf332f14da3csasafgaew23fqw0681"},"description":"Authorization token assigned to the client"},{"name":"year","in":"header","required":true,"schema":{"type":"integer","example":2026},"description":"Year for which the bundle transaction summary should be returned"},{"name":"month","in":"header","required":true,"schema":{"type":"integer","minimum":1,"maximum":12,"example":4},"description":"Month for which the bundle transaction summary should be returned"},{"name":"day","in":"header","required":false,"schema":{"type":"integer","minimum":1,"maximum":31,"example":15},"description":"Optional day of the month for which the bundle transaction summary should be returned. When omitted, the summary covers the entire selected month"},{"name":"client-name","in":"header","required":true,"schema":{"type":"string","example":"example-client"},"description":"Name of the client for which we want to retrieve statistics"}],"responses":{"200":{"description":"Bundle transactions summary returned successfully","content":{"application/json":{"schema":{"type":"object","required":["transactionList","everydayStats","totalNumberOfTransactions","totalNumberOfBundles","totalAmount"],"properties":{"transactionList":{"type":"array","description":"List of bundle transactions for the selected month or day","items":{"type":"object","properties":{"stateId":{"type":"string","example":"33a0cc9a-3f47-11f1-922f-a9744f062a21"},"amount":{"type":"string","example":"0.46"},"currency":{"type":"string","example":"PLN"},"senderAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"senderBank":{"type":"string","example":"fizenbank"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-04-23"},"executionDate":{"type":"string","format":"date","example":"2026-04-23"},"operationType":{"type":"string","example":"BUNDLE"},"userId":{"type":"string","example":"Fizen"},"isSCA":{"type":"boolean","example":true},"bundleId":{"type":"array","description":"Identifiers of payments belonging to the bundle","items":{"type":"string","example":"uuid0"},"example":["uuid0","uuid1"]},"paymentsInBundle":{"type":"integer","example":2},"paymentIndexInBundle":{"type":"integer","example":1},"bundleAmount":{"type":"string","example":"0.92"},"numberOfTransactionsInMonth":{"type":"integer","example":0}}}},"everydayStats":{"type":"object","description":"Daily SCA and non-SCA statistics keyed by date","additionalProperties":{"type":"object","properties":{"scaNumber":{"type":"integer","example":2},"scaAmount":{"type":"string","example":"0.92"},"nonScaNumber":{"type":"integer","example":0},"nonScaAmount":{"type":"string","example":"0.00"}}},"example":{"2026-04-23":{"scaNumber":2,"scaAmount":"0.92","nonScaNumber":0,"nonScaAmount":"0.00"}}},"totalNumberOfTransactions":{"type":"integer","example":2},"totalNumberOfBundles":{"type":"integer","example":1},"totalAmount":{"type":"string","example":"0.92"}}},"example":{"transactionList":[{"stateId":"33a0cc9a-3f47-11f1-922f-a9744f062a21","amount":"0.46","currency":"PLN","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","initType":"Integracja API","initDate":"2026-04-23","executionDate":"2026-04-23","operationType":"BUNDLE","userId":"Fizen","isSCA":true,"bundleId":["uuid0","uuid1"],"paymentsInBundle":2,"paymentIndexInBundle":1,"bundleAmount":"0.92","numberOfTransactionsInMonth":0},{"stateId":"1056ae33-3f47-11f1-922f-c7868c52dccc","amount":"0.46","currency":"PLN","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","initType":"Integracja API","initDate":"2026-04-23","executionDate":"2026-04-23","operationType":"BUNDLE","userId":"Fizen","isSCA":true,"bundleId":["uuid0","uuid1"],"paymentsInBundle":2,"paymentIndexInBundle":2,"bundleAmount":"0.92","numberOfTransactionsInMonth":0}],"everydayStats":{"2026-04-23":{"scaNumber":2,"scaAmount":"0.92","nonScaNumber":0,"nonScaAmount":"0.00"}},"totalNumberOfTransactions":2,"totalNumberOfBundles":1,"totalAmount":"0.92"}}}},"400":{"description":"Bad Request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/fizen-analytics/all-transactions/merchants/summary":{"get":{"tags":["analytics"],"summary":"Get all transactions summary for merchants","description":"Returns a summary of all transactions for merchants available for the provided credentials, covering the selected month or, when the optional day header is provided, the selected day. The response contains the transaction list, daily SCA and non-SCA statistics, and aggregated totals for domestic, recurring, and bundle transactions.","operationId":"GetAllTransactionsMerchantsSummary","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --location 'https://api.app.fizen.com/fizen-analytics/all-transactions/merchants/summary' \\\n--header 'year: 2026' \\\n--header 'month: 5' \\\n--header 'day: 15' \\\n--header 'apikey: 1dffbeac9d959af87667676767676767ef' \\\n--header 'token: OTgwZTY3NzI3NzI3M2YyYTgxYWZmYzMyY7777777778=='\n"}],"parameters":[{"name":"apikey","in":"header","required":true,"schema":{"type":"string","example":"1dffbeac9d959af87667676767676767ef"},"description":"API key assigned to the client"},{"name":"token","in":"header","required":true,"schema":{"type":"string","example":"OTgwZTY3NzI3NzI3M2YyYTgxYWZmYzMyY7777777778=="},"description":"Authorization token assigned to the client"},{"name":"year","in":"header","required":true,"schema":{"type":"integer","example":2026},"description":"Year for which the transaction summary should be returned"},{"name":"month","in":"header","required":true,"schema":{"type":"integer","minimum":1,"maximum":12,"example":5},"description":"Month for which the transaction summary should be returned"},{"name":"day","in":"header","required":false,"schema":{"type":"integer","minimum":1,"maximum":31,"example":15},"description":"Optional day of the month for which the transaction summary should be returned. When omitted, the summary covers the entire selected month"}],"responses":{"200":{"description":"All transactions summary for merchants returned successfully","content":{"application/json":{"schema":{"type":"object","required":["transactionList","everydayStats","totalNumberOfTransactions","totalAmount","totalNumberOfRecurringTransactions","totalRecurringAmount","totalNumberOfBundleTransactions","totalBundleAmount"],"properties":{"transactionList":{"type":"array","description":"List of transactions for the selected month or day. The list may contain domestic, recurring, and bundle transactions.","items":{"oneOf":[{"type":"object","description":"Domestic transaction","properties":{"stateId":{"type":"string","example":"c85d94f3-3f47-11f1-922f-ff0a63ec939e"},"amount":{"type":"string","example":"0.99"},"currency":{"type":"string","example":"PLN"},"senderNameAddress":{"type":"string","example":"Jan Kowalski, ul. Testowa 1, 00-001 Warszawa"},"senderAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"senderBank":{"type":"string","example":"fizenbank"},"recipientNameAddress":{"type":"string","example":"Example Recipient, ul. Prosta 10, 00-002 Warszawa"},"recipientAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"recipientBank":{"type":"string","nullable":true,"example":null},"paymentStatus":{"type":"string","example":"DONE"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-05-23"},"executionDate":{"type":"string","format":"date","example":"2026-05-23"},"operationType":{"type":"string","example":"DOMESTIC"},"userId":{"type":"string","example":"Domestic"},"transferTitle":{"type":"string","example":"Order c85d94f3-3f47-11f1-922f-ff0a63ec939e"},"isSCA":{"type":"boolean","example":true}}},{"type":"object","description":"Recurring transaction","properties":{"stateId":{"type":"string","example":"b63af141-3f47-11f1-922f-2d9fc527509a"},"amount":{"type":"string","example":"0.01"},"currency":{"type":"string","example":"PLN"},"senderNameAddress":{"type":"string","example":"Jan Kowalski, ul. Testowa 1, 00-001 Warszawa"},"senderAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"senderBank":{"type":"string","example":"fizenbank"},"recipientNameAddress":{"type":"string","example":"Example Recipient, ul. Prosta 10, 00-002 Warszawa"},"recipientAccountNumber":{"type":"string","example":"PL12341234123412341234"},"recipientBank":{"type":"string","nullable":true,"example":null},"paymentStatus":{"type":"string","example":"IN_PROGRESS"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-05-23"},"executionDate":{"type":"string","format":"date","example":"2026-05-23"},"operationType":{"type":"string","example":"RECURRING"},"userId":{"type":"string","example":"Fizen"},"transferTitle":{"type":"string","example":"Order b63af141-3f47-11f1-922f-2d9fc527509a"},"isSCA":{"type":"boolean","example":true},"lastExecutionDate":{"type":"string","format":"date","example":"2027-09-17"},"period":{"type":"string","example":"MONTH"},"numberOfTransactionsInMonth":{"type":"integer","example":1},"amountOfTransactionsInMonth":{"type":"string","example":"0.01"},"cancelled":{"type":"boolean","example":false}}},{"type":"object","description":"Bundle transaction","properties":{"stateId":{"type":"string","example":"33a0cc9a-3f47-11f1-922f-a9744f062a21"},"amount":{"type":"string","example":"0.46"},"currency":{"type":"string","example":"PLN"},"senderNameAddress":{"type":"string","example":"Jan Kowalski, ul. Testowa 1, 00-001 Warszawa"},"senderAccountNumber":{"type":"string","example":"PL18109024023536889671897127"},"senderBank":{"type":"string","example":"fizenbank"},"recipientNameAddress":{"type":"string","nullable":true,"example":null},"recipientAccountNumber":{"type":"string","nullable":true,"example":null},"recipientBank":{"type":"string","nullable":true,"example":null},"paymentStatus":{"type":"string","example":"DONE"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-05-23"},"executionDate":{"type":"string","format":"date","example":"2026-05-23"},"operationType":{"type":"string","example":"BUNDLE"},"userId":{"type":"string","example":"Fizen"},"transferTitle":{"type":"string","nullable":true,"example":null},"isSCA":{"type":"boolean","example":true},"bundleId":{"type":"array","description":"Identifiers of payments belonging to the bundle","items":{"type":"string","example":"uuid0"},"example":["uuid0","uuid1"]},"paymentsInBundle":{"type":"integer","example":2},"paymentIndexInBundle":{"type":"integer","example":1},"bundleAmount":{"type":"string","example":"0.92"},"numberOfTransactionsInMonth":{"type":"integer","example":1},"amountOfTransactionsInMonth":{"type":"string","example":"0.46"}}}]}},"everydayStats":{"type":"object","description":"Daily SCA and non-SCA statistics keyed by date","additionalProperties":{"type":"object","properties":{"scaNumber":{"type":"integer","example":4},"scaAmount":{"type":"string","example":"1.92"},"nonScaNumber":{"type":"integer","example":0},"nonScaAmount":{"type":"string","example":"0.00"}}},"example":{"2026-05-23":{"scaNumber":4,"scaAmount":"1.92","nonScaNumber":0,"nonScaAmount":"0.00"}}},"totalNumberOfTransactions":{"type":"integer","example":4},"totalAmount":{"type":"string","example":"1.92"},"totalNumberOfRecurringTransactions":{"type":"integer","example":1},"totalRecurringAmount":{"type":"string","example":"0.01"},"totalNumberOfBundleTransactions":{"type":"integer","example":2},"totalBundleAmount":{"type":"string","example":"0.92"}}},"example":{"transactionList":[{"stateId":"c85d94f3-3f47-11f1-922f-ff0a63ec939e","amount":"0.99","currency":"PLN","senderNameAddress":"Jan Kowalski, ul. Testowa 1, 00-001 Warszawa","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","recipientNameAddress":"Example Recipient, ul. Prosta 10, 00-002 Warszawa","recipientAccountNumber":"PL18109024023536889671897127","recipientBank":null,"paymentStatus":"DONE","initType":"Integracja API","initDate":"2026-05-23","executionDate":"2026-05-23","operationType":"DOMESTIC","userId":"Domestic","transferTitle":"Order c85d94f3-3f47-11f1-922f-ff0a63ec939e","isSCA":true},{"stateId":"b63af141-3f47-11f1-922f-2d9fc527509a","amount":"0.01","currency":"PLN","senderNameAddress":"Jan Kowalski, ul. Testowa 1, 00-001 Warszawa","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","recipientNameAddress":"Example Recipient, ul. Prosta 10, 00-002 Warszawa","recipientAccountNumber":"PL12341234123412341234","recipientBank":null,"paymentStatus":"IN_PROGRESS","initType":"Integracja API","initDate":"2026-05-23","executionDate":"2026-05-23","operationType":"RECURRING","userId":"Fizen","transferTitle":"Order b63af141-3f47-11f1-922f-2d9fc527509a","isSCA":true,"lastExecutionDate":"2027-09-17","period":"MONTH","numberOfTransactionsInMonth":1,"amountOfTransactionsInMonth":"0.01","cancelled":false},{"stateId":"33a0cc9a-3f47-11f1-922f-a9744f062a21","amount":"0.46","currency":"PLN","senderNameAddress":"Jan Kowalski, ul. Testowa 1, 00-001 Warszawa","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","recipientNameAddress":null,"recipientAccountNumber":null,"recipientBank":null,"paymentStatus":"DONE","initType":"Integracja API","initDate":"2026-05-23","executionDate":"2026-05-23","operationType":"BUNDLE","userId":"Fizen","transferTitle":null,"isSCA":true,"bundleId":["uuid0","uuid1"],"paymentsInBundle":2,"paymentIndexInBundle":1,"bundleAmount":"0.92","numberOfTransactionsInMonth":1,"amountOfTransactionsInMonth":"0.46"},{"stateId":"1056ae33-3f47-11f1-922f-c7868c52dccc","amount":"0.46","currency":"PLN","senderNameAddress":"Jan Kowalski, ul. Testowa 1, 00-001 Warszawa","senderAccountNumber":"PL18109024023536889671897127","senderBank":"fizenbank","recipientNameAddress":null,"recipientAccountNumber":null,"recipientBank":null,"paymentStatus":"DONE","initType":"Integracja API","initDate":"2026-05-23","executionDate":"2026-05-23","operationType":"BUNDLE","userId":"Fizen","transferTitle":null,"isSCA":true,"bundleId":["uuid0","uuid1"],"paymentsInBundle":2,"paymentIndexInBundle":2,"bundleAmount":"0.92","numberOfTransactionsInMonth":1,"amountOfTransactionsInMonth":"0.46"}],"everydayStats":{"2026-05-23":{"scaNumber":4,"scaAmount":"1.92","nonScaNumber":0,"nonScaAmount":"0.00"}},"totalNumberOfTransactions":4,"totalAmount":"1.92","totalNumberOfRecurringTransactions":1,"totalRecurringAmount":"0.01","totalNumberOfBundleTransactions":2,"totalBundleAmount":"0.92"}}}},"400":{"description":"Bad Request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}},"/fizen-analytics/all-transactions/merchants/grouped/summary":{"get":{"tags":["analytics"],"summary":"Get grouped all transactions summary for merchants","description":"Returns an all-transactions summary grouped by merchant/client for the selected month or, when the optional day header is provided, for the selected day. Each item in the response represents one client and contains the transaction list for the selected period.","operationId":"GetGroupedAllTransactionsMerchantsSummary","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --location 'https://api.app.fizen.com/fizen-analytics/all-transactions/merchants/grouped/summary' \\\n--header 'year: 2026' \\\n--header 'month: 4' \\\n--header 'day: 15' \\\n--header 'apikey: 1dffbe345354wrjfnrjnjnfjnfcc3c77ef' \\\n--header 'token: OTgwZTY3NzI3NzI3M2YyY433434355355JmYWY5ZWI0OQ=='\n"}],"parameters":[{"name":"apikey","in":"header","required":true,"schema":{"type":"string","example":"1dffbe345354wrjfnrjnjnfjnfcc3c77ef"},"description":"API key assigned to the client"},{"name":"token","in":"header","required":true,"schema":{"type":"string","example":"OTgwZTY3NzI3NzI3M2YyY433434355355JmYWY5ZWI0OQ=="},"description":"Authorization token assigned to the client"},{"name":"year","in":"header","required":true,"schema":{"type":"integer","example":2026},"description":"Year for which grouped transaction summary should be returned"},{"name":"month","in":"header","required":true,"schema":{"type":"integer","minimum":1,"maximum":12,"example":4},"description":"Month for which grouped transaction summary should be returned"},{"name":"day","in":"header","required":false,"schema":{"type":"integer","minimum":1,"maximum":31,"example":15},"description":"Optional day of the month for which the grouped transaction summary should be returned. When omitted, the summary covers the entire selected month"}],"responses":{"200":{"description":"Grouped all-transactions summary for merchants returned successfully","content":{"application/json":{"schema":{"type":"array","description":"List of transaction summaries grouped by client","items":{"type":"object","required":["clientName","transactions"],"properties":{"clientName":{"type":"string","description":"Name of the client/merchant","example":"Finansowo_Meest"},"transactions":{"type":"array","description":"List of transactions for the selected client and selected month or day. The list may contain domestic, recurring, and bundle transactions.","items":{"oneOf":[{"type":"object","description":"Domestic transaction","properties":{"stateId":{"type":"string","example":"c8b1424e-3666-11f1-8b0d-9987638aafe9"},"amount":{"type":"string","example":"29.32"},"currency":{"type":"string","example":"PLN"},"senderNameAddress":{"type":"string","nullable":true,"example":null},"senderAccountNumber":{"type":"string","nullable":true,"example":null},"senderBank":{"type":"string","example":"mbank"},"recipientNameAddress":{"type":"string","example":"Łukasz Wojdak"},"recipientAccountNumber":{"type":"string","example":"PL60105010251000009141943168"},"recipientBank":{"type":"string","nullable":true,"example":null},"paymentStatus":{"type":"string","example":"PENDING"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-04-12"},"executionDate":{"type":"string","format":"date","example":"2026-04-12"},"operationType":{"type":"string","example":"DOMESTIC"},"userId":{"type":"string","example":"414224"},"transferTitle":{"type":"string","example":"UIP Finansowo.pl - spłata raty nr 10 pożyczki nr 83725985"},"isSCA":{"type":"boolean","example":true}}},{"type":"object","description":"Recurring transaction","properties":{"stateId":{"type":"string","example":"b63af141-3f47-11f1-922f-2d9fc527509a"},"amount":{"type":"string","example":"0.01"},"currency":{"type":"string","example":"PLN"},"senderNameAddress":{"type":"string","nullable":true,"example":null},"senderAccountNumber":{"type":"string","nullable":true,"example":null},"senderBank":{"type":"string","example":"mbank"},"recipientNameAddress":{"type":"string","example":"Example Recipient"},"recipientAccountNumber":{"type":"string","example":"PL12341234123412341234"},"recipientBank":{"type":"string","nullable":true,"example":null},"paymentStatus":{"type":"string","example":"IN_PROGRESS"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-04-12"},"executionDate":{"type":"string","format":"date","example":"2026-04-12"},"operationType":{"type":"string","example":"RECURRING"},"userId":{"type":"string","example":"414224"},"transferTitle":{"type":"string","example":"Recurring payment title"},"period":{"type":"string","example":"MONTH"},"lastExecutionDate":{"type":"string","format":"date","example":"2027-09-17"},"cancelDate":{"type":"string","format":"date","nullable":true,"example":null},"cancelled":{"type":"boolean","example":false},"numberOfTransactionsInMonth":{"type":"integer","example":1},"amountOfTransactionsInMonth":{"type":"string","example":"0.01"},"isSCA":{"type":"boolean","example":true}}},{"type":"object","description":"Bundle transaction","properties":{"stateId":{"type":"string","example":"33a0cc9a-3f47-11f1-922f-a9744f062a21"},"amount":{"type":"string","example":"0.46"},"currency":{"type":"string","example":"PLN"},"senderNameAddress":{"type":"string","nullable":true,"example":null},"senderAccountNumber":{"type":"string","nullable":true,"example":null},"senderBank":{"type":"string","example":"mbank"},"recipientNameAddress":{"type":"string","nullable":true,"example":null},"recipientAccountNumber":{"type":"string","nullable":true,"example":null},"recipientBank":{"type":"string","nullable":true,"example":null},"paymentStatus":{"type":"string","example":"DONE"},"initType":{"type":"string","example":"Integracja API"},"initDate":{"type":"string","format":"date","example":"2026-04-12"},"executionDate":{"type":"string","format":"date","example":"2026-04-12"},"operationType":{"type":"string","example":"BUNDLE"},"userId":{"type":"string","example":"414224"},"transferTitle":{"type":"string","nullable":true,"example":null},"bundleId":{"type":"array","description":"Identifiers of payments belonging to the bundle","items":{"type":"string","example":"uuid0"},"example":["uuid0","uuid1"]},"paymentsInBundle":{"type":"integer","example":2},"paymentIndexInBundle":{"type":"integer","example":1},"bundleAmount":{"type":"string","example":"0.92"},"numberOfTransactionsInMonth":{"type":"integer","example":1},"amountOfTransactionsInMonth":{"type":"string","example":"0.46"},"isSCA":{"type":"boolean","example":true}}}]}}}}},"example":[{"clientName":"Finansowo_Meest","transactions":[{"stateId":"c8b1424e-3666-11f1-8b0d-9987638aafe9","amount":"29.32","currency":"PLN","senderBank":"mbank","recipientNameAddress":"Łukasz Wojdak","recipientAccountNumber":"PL60105010251000009141943168","paymentStatus":"PENDING","initType":"Integracja API","initDate":"2026-04-12","executionDate":"2026-04-12","operationType":"DOMESTIC","userId":"414224","transferTitle":"UIP Finansowo.pl - spłata raty nr 10 pożyczki nr 83725985","isSCA":true}]},{"clientName":"Example_Client","transactions":[{"stateId":"b63af141-3f47-11f1-922f-2d9fc527509a","amount":"0.01","currency":"PLN","senderBank":"mbank","recipientNameAddress":"Example Recipient","recipientAccountNumber":"PL12341234123412341234","paymentStatus":"IN_PROGRESS","initType":"Integracja API","initDate":"2026-04-12","executionDate":"2026-04-12","operationType":"RECURRING","userId":"414224","transferTitle":"Recurring payment title","period":"MONTH","lastExecutionDate":"2027-09-17","cancelDate":null,"cancelled":false,"numberOfTransactionsInMonth":1,"amountOfTransactionsInMonth":"0.01","isSCA":true}]}]}}},"400":{"description":"Bad Request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FizenError"}}}}}}}},"components":{"schemas":{"SignResp":{"type":"array","items":{"type":"object","properties":{"bankId":{"type":"string","description":"Bank identifier","example":"alior"},"bankName":{"type":"string","description":"Bank Name","example":"Alior Bank"},"apiVersion":{"type":"string","description":"Bank API version","example":"v3_0.1"},"retailUrl":{"type":"string","description":"The authorization service for consent to a retail bank account access and initiate payment (for specific operation type AIS, PIS_DOMESTIC, PIS_RECURRING).","example":"http://api.sandbox.fizen.com/alior/initiate/"},"companyUrl":{"type":"string","description":"The authorization service for consent to a company bank account access (for operation type AIS)","example":"http://api.sandbox.fizen.com/alior-company/initiate/"},"jdgSupportedOnRetail":{"type":"boolean","description":"Indicates whether sole proprietorship accounts (JDG – \"jednoosobowa działalność gospodarcza\") are supported via retail consent initialization endpoints. When set to true, JDG accounts should use the \"retail\" flow instead of the \"company\" flow.","example":true},"health":{"type":"array","description":"Confirmed bank api availability","example":true},"senderAccount":{"type":"array","description":"Transfer Sender Account Number is/isn't sent in POST back (for operation Type PIS_DOMESTIC)","example":true},"active":{"type":"array","description":"Activated/deactivated bank in Fizen API","example":true}}}},"PaymentResp":{"type":"object","properties":{"banks":{"$ref":"#/components/schemas/SignResp"}}},"FizenError":{"type":"object","properties":{"status":{"type":"string","description":"Error status","example":"BAD_REQUEST"},"errorMessage":{"type":"string","description":"Error message.","example":"Validation exception - Missing request header 'apiKey' for method parameter of type String"},"bank":{"type":"string","description":"Bank identifier","example":"MBANK"},"clientName":{"type":"string","description":"Client name given by Fizen","example":"KLIENT1"},"state":{"type":"string","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"d2b75e70-c735-10rd-9018-4510c14d98bc"},"dateTime":{"type":"string","format":"date-time","description":"Timestamp with the following format YYYY-MM-DD","example":"2022-10-14T18:46:41.821666"},"errorId":{"type":"string","description":"API Fizen error identifier","example":"FIZEN_ERROR_UNKNOWN_UNKNOWN_20221003T104705365314_F508718D42F711ED929F2FD8F8242F0C"}}},"InitResp":{"type":"object","properties":{"state":{"type":"string","description":"The value generated for when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service) and initiate a payment (PIS service)","example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV9iYmRjYTc0NC01MDcxLTExZWQtYWY1Zi1hZGVjZDM3MzQyZjRfaW5nX2JiZGNhNzQzLTUwNzEtMTFlZC1hZjVmLTJiMTMzMTA5MjVmZQ=="},"redirectUri":{"type":"string","description":"A bank interface URI the end user uses to authorize consent for access to a retail bank account (AIS) or initiate a payment (PIS service)","example":"https://bankdomain.pl/login/#/7f7edab4-1cf4-4d0f-ab31-d9a574d86a0d"}}},"FizenError404":{"type":"object","properties":{"status":{"type":"string","description":"Error status","example":"Not Found"},"errorMessage":{"type":"string","description":"Error message","example":"State not cached or State improper for bank Exception"},"bank":{"type":"string","description":"Bank identifier","example":"ING"},"clientName":{"type":"string","description":"Client name given by Fizen","example":"KLIENT1"},"state":{"type":"string","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},"dateTime":{"type":"string","format":"date-time","description":"Timestamp with the following format YYYY-MM-DD","example":"2022-10-14T18:46:41.821666"},"errorId":{"type":"string","description":"API Fizen error identifier","example":"FIZEN_ERROR_FIZEN_UNKNOWN_20230309T172805934548_5EDE9D96BE9711ED92D8F32AC3D7ADD5"},"sendPostWithError":{"type":"string","description":null,"example":true},"rawClientName":{"type":"string","description":"The name of the client in its original (raw) format as provided in the request.","example":"klient1"}}},"FizenError430":{"type":"object","properties":{"status":{"type":"string","description":"Error status","example":"Request Failed"},"errorMessage":{"type":"string","description":"Error message","example":"Api Bank service error - please contact Fizen in order to resolve the issue. Remember to attach errorId."},"bank":{"type":"string","description":"Bank identifier","example":"ING"},"clientName":{"type":"string","description":"Client name given by Fizen","example":"KLIENT1"},"state":{"type":"string","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},"dateTime":{"type":"string","format":"date-time","description":"Timestamp with the following format YYYY-MM-DD","example":"2022-10-14T18:46:41.821666"},"errorId":{"type":"string","description":"API Fizen error identifier","example":"FIZEN_ERROR_FIZEN_UNKNOWN_20230309T172805934548_5EDE9D96BE9711ED92D8F32AC3D7ADD5"},"sendPostWithError":{"type":"boolean","description":"Indicates whether Fizen will send an error notification POST according to the client's configuration.","example":true},"rawClientName":{"type":"string","description":"The name of the client in its original (raw) format as provided in the request.","example":"klient1"},"bankResponseCode":{"type":"integer","description":"Optional bank response code. This field is returned only when enabled in the client's configuration.","example":430},"bankResponseMessage":{"type":"string","description":"Optional bank response message. This field is returned only when enabled in the client's configuration.","example":"Bank rejected the request."}}},"FizenError500":{"type":"object","properties":{"status":{"type":"string","description":"Error status","example":"INTERNAL_SERVER_ERROR"},"errorMessage":{"type":"string","description":"Error message","example":"Internal server error - please contact Fizen in order to resolve the issue. Remember to attach errorId."},"bank":{"type":"string","description":"Bank identifier","example":"MBANK"},"clientName":{"type":"string","description":"Client name given by Fizen","example":"KLIENT1"},"state":{"type":"string","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},"dateTime":{"type":"string","format":"date-time","description":"Timestamp with the following format YYYY-MM-DD","example":"2022-10-14T18:46:41.821666"},"errorId":{"type":"string","description":"API Fizen error identifier","example":"FIZEN_ERROR_FIZEN_MBANK_20221003T105358370556_EB34C50742F811EDA37211747EA65C35"},"sendPostWithError":{"type":"string","description":null,"example":true},"rawClientName":{"type":"string","description":"The name of the client in its original (raw) format as provided in the request.","example":"klient1"}}},"AccountsArrayPostResponse":{"type":"object","properties":{"accountId":{"type":"string","description":"Account Id","example":"TDBrRUhnT1cwNWNtYlNlcasdasdasdasd1eERIWTNGU3FTTk9JaGNmdfsdfsdfds5bDRTMk10NVI3b25UUQ=="}}},"AisCallbackResponse":{"type":"object","properties":{"state":{"type":"string","description":"The value generated for when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service) and initiate a payment (PIS service)","example":"44cbcvb6-f6c8-11ee-test-1bedccc3f6d2"},"userId":{"type":"string","description":"UserId is a unique identifier for a user used to distinguish and access specific user-related information.","example":"Fizen"},"bankId":{"type":"string","description":"Identifier of the bank related to the request.","example":"mbank"},"accounts":{"type":"array","description":"A table containing 'accountId' identifiers through which user accounts can be identified.","example":[{"accountId":"TDBrRUhnT1cASDASD23423432443243254534534lcjUDASDASDasdsdadaRTMk10NVI3b25UUQ=="},{"accountId":"c2xYNVhldWpVUUdtbS9INW53c2k0M2FSDADSDAFApc2pVVmZUQ2k1WXRCd1pKVFg0TWl1bFBncQ=="}],"items":{"$ref":"#/components/schemas/AccountsArrayPostResponse"}},"consentExpirationDateTime":{"type":"string","format":"date-time","description":"Date and time when the user's consent expires. After this moment, access to account data is no longer allowed.","example":"2026-06-08T13:07:25.755Z"}}},"ErrorCallbackResponse":{"type":"object","description":"Represents an error returned during request processing.","properties":{"errorId":{"type":"string","description":"A unique identifier for the error.","example":"f1e2b7d3-3dbe-442b-bc3f-95de10fe2e5f"},"errorDetails":{"type":"string","description":"A detailed message describing the nature of the error.","example":"Missing required NIP for bank paribas-company"},"bankId":{"type":"string","description":"Identifier of the bank related to the request.","example":"mbank"},"state":{"type":"string","description":"Unique internal state identifier used to track the request.","example":"79d937fb-e8bb-4d4f-9db4-1aab9240e0a4"},"userId":{"type":"string","description":"Unique user identifier, generated on the client's side.","example":"user-9f01e212"}}},"ErrorCallbackRequest":{"type":"object","description":"Error notification sent by Fizen to the client's configured error callback endpoint.","properties":{"errorId":{"type":"string","description":"A unique identifier for the error.","example":"f1e2b7d3-3dbe-442b-bc3f-95de10fe2e5f"},"errorDetails":{"type":"string","description":"A detailed message describing the nature of the error.","example":"Bank rejected the payment"},"bankId":{"type":"string","description":"Identifier of the bank related to the request.","example":"mbank"},"state":{"type":"string","description":"Unique internal state identifier used to track the request.","example":"79d937fb-e8bb-4d4f-9db4-1aab9240e0a4"},"userId":{"type":"string","description":"Unique user identifier, generated on the client's side.","example":"user-9f01e212"},"bankResponseCode":{"type":"integer","description":"Optional bank response code. This field is included in the error notification only when enabled in the client's configuration.","example":430},"bankResponseMessage":{"type":"string","description":"Optional bank response message. This field is included in the error notification only when enabled in the client's configuration.","example":"Bank rejected the payment"}}},"AccountDTO":{"type":"object","properties":{"nameAddress":{"type":"string","description":"Account owner name address field","example":"Jan Kowalski, ul. Malinowa 12, Warszawa"},"accountNumber":{"type":"string","description":"Account number","example":"PL47105000282100002303150001"},"currency":{"type":"string","description":"Account currency","example":"PL"},"availableBalance":{"type":"string","description":"Available account balance","example":"11012.34"},"bookingBalance":{"type":"string","description":"Booking account balance","example":"15112.34"},"accountDescription":{"type":"string","description":"Account description","example":"current account"},"accountId":{"type":"string","description":"Account identifier","example":"ExampleAccountIIVzdweGpkUS95OTNnOTdxMXZrOEk0QjUwOU1tU2iMA=="}}},"AccountDetailsResp":{"type":"object","properties":{"state":{"type":"string","description":"The value generated for when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV9iYmRjYTc0NC01MDcxLTExZWQtYWY1Zi1hZGVjZDM3MzQyZjRfaW5nX2JiZGNhNzQzLTUwNzEtMTFlZC1hZjVmLTJiMTMzMTA5MjVmZQ=="},"userId":{"type":"string","description":"End user ID, generated on the client's side when initiating the request from FIZEN API","example":432532453425},"consentExpirationDateTime":{"type":"string","format":"date-time","description":"Date and time when the user's consent expires. After this moment, access to account data is no longer allowed.","example":"2026-06-08T13:07:25.755Z"},"details":{"$ref":"#/components/schemas/AccountDTO"}}},"TransactionPartyDTO":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Account number","example":"PL47105000282100002303150001"},"nameAddress":{"type":"string","description":"Name address field","example":"John Werner, Berliner street 12, London"}}},"TransactionDTO":{"type":"object","properties":{"id":{"type":"string","description":"Transaction id","example":"Credit card technical account"},"description":{"type":"string","description":"Transaction description","example":"Payment for order number 3456"},"status":{"type":"string","description":"Transaction status","example":"DONE","enum":["PENDING","DONE","SCHEDULED","REJECTED","CANCELED","HOLD"]},"category":{"type":"string","description":"Transaction category","example":"CREDIT","enum":["CREDIT","DEBIT"]},"type":{"type":"string","description":"Transaction type","example":"TRANSFER"},"amount":{"type":"string","description":"Transaction amount","example":"0.99"},"tradeDate":{"type":"string","description":"Transaction execution date (YYYY-MM-DD)","example":"2025-01-17"},"currency":{"type":"string","description":"Transaction currency","example":"EUR"},"sender":{"$ref":"#/components/schemas/TransactionPartyDTO"},"recipient":{"$ref":"#/components/schemas/TransactionPartyDTO"}}},"TransactionListResp":{"type":"object","properties":{"state":{"type":"string","description":"The value generated for when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV9iYmRjYTc0NC01MDcxLTExZWQtYWY1Zi1hZGVjZDM3MzQyZjRfaW5nX2JiZGNhNzQzLTUwNzEtMTFlZC1hZjVmLTJiMTMzMTA5MjVmZQ=="},"userId":{"type":"string","description":"Unique end user ID, generated on the client's side when initiating the request from FIZEN API","example":432532453425},"consentExpirationDateTime":{"type":"string","format":"date-time","description":"Date and time when the user's consent expires. After this moment, access to account data is no longer allowed.","example":"2026-06-08T13:07:25.755Z"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDTO"}},"transactionsStatusesFetchFailures":{"type":"array","description":"A list of transaction types that failed to be retrieved.","items":{"type":"string","enum":["DONE","PENDING","SCHEDULED","REJECTED","CANCELLED"]}}}},"KycDetailsResp":{"type":"object","properties":{"state":{"type":"string","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV9iYmRjYTc0NC01MDcxLTExZWQtYWY1Zi1hZGVjZDM3MzQyZjRfaW5nX2JiZGNhNzQzLTUwNzEtMTFlZC1hZjVmLTJiMTMzMTA5MjVmZQ=="},"userId":{"type":"string","description":"Unique end user ID, generated on the client's side when initiating the request from FIZEN API","example":432532453425},"nameAddress":{"type":"string","description":"User name and address","example":"Agata Nowak ul. Astrów 12/1 40-748 Katowice"}}},"PisDomesticCallbackResponse":{"type":"object","properties":{"state":{"type":"string","description":"The value generated for when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service) and initiate a payment (PIS service)","example":"44cbcvb6-f6c8-11ee-test-1bedccc3f6d2"},"userId":{"type":"string","description":"Unique user identifier, generated on the client's side.","example":"Fizen"},"bankId":{"type":"string","description":"Identifier of the bank related to the request.","example":"mbank"},"paymentStatus":{"type":"string","description":"Payment status contains information about the status of a specific payment.","example":"SUBMITTED"},"amount":{"type":"string","description":"Value representing information about the money value of the transfer.","example":0.99},"senderAccount":{"type":"string","description":"The SenderAccount field contains sender's account number.","example":"PL49102028922276300500000000"}}},"PaymentStatus":{"type":"object","properties":{"userId":{"type":"string","description":"The unique identifier of the end user initiating the payment. The value is generated by the client and passed to the Fizen API.","example":432532453425},"bankId":{"type":"string","description":"Bank identifier the user will authorize consent for Account Information Service (AIS) and Payment Initiation Services (PIS)","example":"alior"},"paymentStatus":{"type":"string","description":"Payment status","example":"DONE"},"amount":{"type":"string","description":"Payment amount. Format: d+.d{2}\n","example":0.99},"senderAccount":{"type":"string","description":"Transfer Sender Account Number","example":"PL44160084586221235245815289"}}},"BundlePayment":{"type":"object","properties":{"senderAccountNumber":{"type":"string","description":"Sender's account number used for initiating the payment.","example":"PL12109010140000071219812874"},"senderNameAddress":{"type":"string","description":"Sender's name and address combined as a single string.","example":"Jan Kowalski, ul. Polna 3, 00-001 Warszawa"},"payments":{"type":"array","description":"List of payment instructions","items":{"type":"object","properties":{"amount":{"type":"string","description":"Payment amount. Format: d+.d{2}\n","example":"1.00"},"accountNumber":{"type":"string","description":"Recipient's account","example":"PL92124049371831347560745013"},"accountName":{"type":"string","description":"Recipient's name","example":"Company Name SA"},"accountAddress":{"type":"string","description":"Recipient's address","example":"Company Address"},"title":{"type":"string","description":"Transfer title","example":"FV VAT 20/04/2023"},"currency":{"type":"string","description":"Transfer currency","example":"PLN"},"executionDate":{"type":"string","format":"date-time","description":"Date of the execution transfer","example":"2025-09-15"}}},"example":[{"amount":"1.00","accountNumber":"PL92124049371831347560745013","accountName":"Company 1","accountAddress":"Address 1","title":"FV VAT 21/04/2025","currency":"PLN","executionDate":"2025-09-15"},{"amount":"2.50","accountNumber":"PL92124049371831347560745013","accountName":"Company 2","accountAddress":"Address 2","title":"FV VAT 20/04/2025","currency":"PLN","executionDate":"2025-10-01"}]}}},"BundlePaymentsRequest":{"type":"array","items":{"$ref":"#/components/schemas/BundlePayment"}},"BundlePaymentsResponse":{"type":"object","properties":{"state":{"type":"string","description":"Identifier of the request/session","example":"28a0827e-2fe1-11f0-8c89-f71a8be202a4"},"redirectUri":{"type":"string","format":"uri","description":"Redirect URL after successful initiation","example":"https://devportal.bank.pl/login/#/cfk97460-7f86-4165-b5h3-j2fd93h4eaf8"},"payments":{"type":"array","description":"List of payment instructions","items":{"type":"object","properties":{"amount":{"type":"string","description":"Payment amount. Format: d+.d{2}\n","example":"1.00"},"accountNumber":{"type":"string","description":"Recipient's account","example":"PL92124049371831347560745013"},"accountName":{"type":"string","description":"Recipient's name","example":"Company Name SA"},"accountAddress":{"type":"string","description":"Recipient's address","example":"Company Address SA"},"title":{"type":"string","description":"Transfer title","example":"FV VAT 20/04/2023"},"currency":{"type":"string","description":"Transfer currency","example":"PLN"},"executionDate":{"type":"string","format":"date-time","description":"Date of the execution transfer","example":"2026-08-12"},"uuid":{"type":"string","description":"Unique ID of the single payment","example":"28a05b6b-2fe1-11f0-8c89-bba57c1fcfb6"}}},"example":[{"amount":"1.00","accountNumber":"PL92124049371831347560745013","accountName":"Company 1","accountAddress":"Address 1","title":"FV VAT 21/04/2025","currency":"PLN","executionDate":"2025-09-15"},{"amount":"2.50","accountNumber":"PL92124049371831347560745013","accountName":"Company 2","accountAddress":"Address 2","title":"FV VAT 20/04/2025","currency":"PLN","executionDate":"2025-10-01"}]}}},"InitRespBundle":{"type":"array","properties":{"state":{"type":"string","description":"The value generated for when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service) and initiate a payment (PIS service)","example":"ODY5MzQ4NWMyNjk4ZmYwMzE2ZjE0ZGEzYzMwYTE4Yzk3YTRkMDY4MV9iYmRjYTc0NC01MDcxLTExZWQtYWY1Zi1hZGVjZDM3MzQyZjRfaW5nX2JiZGNhNzQzLTUwNzEtMTFlZC1hZjVmLTJiMTMzMTA5MjVmZQ=="},"redirectUri":{"type":"string","description":"A bank interface URI the end user uses to authorize consent for access to a retail bank account (AIS) or initiate a payment (PIS service)","example":"https://bankdomain.pl/login/#/7f7edab4-1cf4-4d0f-ab31-d9a574d86a0d"},"payments":{"$ref":"#/components/schemas/BundlePaymentsResponse"}},"items":{"$ref":"#/components/schemas/BundlePaymentsResponse"}},"BundlePaymentsStatus":{"type":"object","properties":{"amount":{"type":"string","description":"Payment amount. Format: d+.d{2}\n","example":0.99},"accountNumber":{"type":"string","description":"Recipient's account","example":"PL92124049371831347560745013"},"accountName":{"type":"string","description":"Recipient's name","example":"Company Name SA"},"accountAddress":{"type":"string","description":"Recipient's address","example":"Company Addresss"},"title":{"type":"string","description":"Transfer title","example":"FV VAT 20/04/2023"},"currency":{"type":"string","description":"Transfer currency","example":"PLN"},"executionDate":{"type":"string","format":"date-time","description":"Date of the execution transfer","example":"2023-04-28"},"uuid":{"type":"string","description":"single payment id","example":"28c77254-fafe-11ed-854a-d5c1496c6a3d"},"paymentStatus":{"type":"string","description":"single payment status","example":"SCHEDULED"}},"example":[{"amount":"120.00","accountNumber":"PL92124049371831347560745013","accountName":"Example Company SA","accountAddress":"ul. Przykładowa 1, 00-001 Warszawa","title":"FV VAT 14/05/2025","currency":"PLN","executionDate":"2025-05-20T00:00:00Z","uuid":"1f4a7c32-5b3f-11ee-8c99-0242ac120002","paymentStatus":"SCHEDULED"},{"amount":"1250.00","accountNumber":"PL92124049371831347560745013","accountName":"Example Company SA","accountAddress":"ul. Przykładowa 1, 00-001 Warszawa","title":"FV VAT 12/05/2025","currency":"PLN","executionDate":"2025-05-20T00:00:00Z","uuid":"1f4a7c32-5b3f-11ee-8c99-0242ac120002","paymentStatus":"SCHEDULED"}]},"PisBundleCallbackResponse":{"type":"object","properties":{"state":{"type":"string","description":"The value generated for when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service) and initiate a payment (PIS service)","example":"44cbcvb6-f6c8-11ee-test-1bedccc3f6d2"},"userId":{"type":"string","description":"Unique user identifier, generated on the client's side.","example":"Fizen"},"bankId":{"type":"string","description":"Identifier of the bank related to the request.","example":"mbank"},"bundleStatus":{"type":"string","description":"Bundle Payment status contains information about the status of a specific payment.","example":"IN_PROGRESS"},"amount":{"type":"string","description":"Value representing information about the money value of the transfer.","example":0.99},"payments":{"type":"array","description":"Payments array.","items":{"$ref":"#/components/schemas/BundlePaymentsStatus"}}}},"BundleStatus":{"type":"object","properties":{"userId":{"type":"string","description":"User id","example":"Fizen"},"bankId":{"type":"string","description":"Bank name","example":"mbank"},"bundleStatus":{"type":"string","description":"Bundle Payment status contains information about the status of a specific payment.","example":"IN_PROGRESS"},"amount":{"type":"string","description":"Value representing information about the money value of the transfer.","example":0.99},"payments":{"type":"array","description":"Payments array.","items":{"$ref":"#/components/schemas/BundlePaymentsStatus"}}}},"FizenError429":{"type":"object","properties":{"status":{"type":"string","description":"Error status","example":"Request Failed"},"errorMessage":{"type":"string","description":"Error message","example":"AIS limited exceeded exception. Try again tomorrow or in 24 hours from last successful request."},"bank":{"type":"string","description":"Bank identifier","example":"ING"},"clientName":{"type":"string","description":"Client name given by Fizen","example":"KLIENT1"},"state":{"type":"string","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},"dateTime":{"type":"string","format":"date-time","description":"Timestamp with the following format YYYY-MM-DD","example":"2022-10-14T18:46:41.821666"},"errorId":{"type":"string","description":"API Fizen error identifier","example":"FIZEN_ERROR_FIZEN_UNKNOWN_20230309T172805934548_5EDE9D96BE9711ED92D8F32AC3D7ADD5"},"sendPostWithError":{"type":"string","description":null,"example":true},"rawClientName":{"type":"string","description":"The name of the client in its original (raw) format as provided in the request.","example":"klient1"}}},"FizenError401":{"type":"object","properties":{"status":{"type":"string","description":"Error status","example":"Unauthorized"},"errorMessage":{"type":"string","description":"Error message","example":"State not cached or State improper for bank Exception"},"bank":{"type":"string","description":"Bank identifier","example":"ING"},"clientName":{"type":"string","description":"Client name given by Fizen","example":"KLIENT1"},"state":{"type":"string","description":"The value generated when starting the linking process for the particular bank interface to authorize consent to retrieve the account information (AIS service)","example":"d2b75e70-c735-13ed-9018-4510c14d98bc"},"dateTime":{"type":"string","format":"date-time","description":"Timestamp with the following format YYYY-MM-DD","example":"2022-10-14T18:46:41.821666"},"errorId":{"type":"string","description":"API Fizen error identifier","example":"FIZEN_ERROR_FIZEN_UNKNOWN_20230309T172805934548_5EDE9D96BE9711ED92D8F32AC3D7ADD5"},"sendPostWithError":{"type":"string","description":null,"example":true},"rawClientName":{"type":"string","description":"The name of the client in its original (raw) format as provided in the request.","example":"klient1"}}}},"callbacks":{"AisCallback":{"AIS callback result":{"post":{"summary":"Account Information Service callback","responses":{"200":{"description":"Callback payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AisCallbackResponse"}}}},"500":{"description":"Error callback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCallbackResponse"}}}}}}}},"ErrorCallback":{"Error callback result":{"post":{"summary":"Error callback","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCallbackRequest"},"examples":{"errorNotification":{"summary":"Error notification sent by Fizen","value":{"errorId":"f9b8a9cd-...","errorDetails":"Bank rejected the payment","bankId":"mbank","state":"d42fa...","userId":"user-123","bankResponseCode":430,"bankResponseMessage":"Bank rejected the payment"}}}}}},"responses":{"200":{"description":"Error notification accepted"},"500":{"description":"Internal server error while processing the callback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCallbackResponse"},"examples":{"example1":{"summary":"Example error response","value":{"errorId":"f9b8a9cd-...","errorDetails":"Missing required NIP","bankId":"mbank","state":"d42fa...","userId":""}}}}}}}}}},"PisCallback":{"PIS callback result":{"post":{"summary":"Payment Information Service callback","responses":{"200":{"description":"Callback payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PisDomesticCallbackResponse"}}}},"500":{"description":"Error callback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCallbackResponse"}}}}}}}},"PisBundleCallback":{"PIS callback result":{"post":{"summary":"Bundle Payment Information Service callback","responses":{"200":{"description":"Callback payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PisBundleCallbackResponse"}}}},"500":{"description":"Error callback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCallbackResponse"}}}}}}}}}}}