# Bridge API Documentation Documentation

> Unlock the Power of Open Banking for Seamless Payments and Financial Services Bridge is your gateway to the world of Open Banking, making payment initiation and collection effortless with cutting-edge technology. Whether you're a small startup or a large enterprise, Bridge empowers businesses of all sizes to seamlessly integrate our platform, creating a foundation for innovative and competitive 360-degree financial services.

## Guides
- [Welcome](https://docs.bridgeapi.io/docs/quickstart.md)
- [Dashboard](https://docs.bridgeapi.io/docs/dashboard.md)
- [API credentials](https://docs.bridgeapi.io/docs/api-credentials.md)
- [API basics](https://docs.bridgeapi.io/docs/basics.md)
- [Migration guide from 2021 to 2025 version](https://docs.bridgeapi.io/docs/migration-guide-from-2021-to-2025-version.md): This page outlines the technical changes introduced in the latest API version, intended to assist developers in migrating and adapting to the updated functionality
- [Migration guide from 2019 to 2025 version](https://docs.bridgeapi.io/docs/migration-guide-from-2019-to-2025.md): This page outlines the technical changes introduced in the latest API version, intended to assist developers in migrating and adapting to the updated functionality
- [🆕 BridgeAPI docs for AI Agents & LLMs](https://docs.bridgeapi.io/docs/bridgeapi-for-ai-agents-llms.md): BridgeAPI documentation is AI-accessible. We provide specialized interfaces and high-portability content formats designed specifically for Large Language Models (LLMs) and AI Agents. Whether you are building with Claude, Codex, ChatGPT, or AI-powered IDEs like Cursor and Windsurf, our documentation is optimized to give your tools the context they need with zero friction.
- [Presentation](https://docs.bridgeapi.io/docs/presentation-2.md)
- [Create your app](https://docs.bridgeapi.io/docs/create-your-app.md)
- [Configure](https://docs.bridgeapi.io/docs/configure-1.md)
- [Customize](https://docs.bridgeapi.io/docs/customize-1.md)
- [Financial Data Aggregation](https://docs.bridgeapi.io/docs/exposed-resources.md)
- [User creation and authentication](https://docs.bridgeapi.io/docs/user-creation-authentication.md)
- [First synchronization](https://docs.bridgeapi.io/docs/first-synchronization.md)
- [User management sessions](https://docs.bridgeapi.io/docs/user-management-sessions.md): This feature is a wrapper of connect sessions created to facilitate your integration by including several features like status handling/description, add of a new item after a connect session, management of shared accounts, etc.
- [Data fetching](https://docs.bridgeapi.io/docs/data-fetching.md)
- [Manage your item lifecycle](https://docs.bridgeapi.io/docs/manage-the-lifecycle.md)
- [Manage your transactions](https://docs.bridgeapi.io/docs/manage-your-transactions.md): Now that you manage the lifecycle of your connections it is important to manage your transactions updates.
- [Manage your accounts](https://docs.bridgeapi.io/docs/manage-your-accounts.md): Now that you manage the lifecycle of your transactions it is important to manage your user's accounts.
- [Items statuses](https://docs.bridgeapi.io/docs/items-status.md)
- [Operation types and deferred debit card](https://docs.bridgeapi.io/docs/operation-types.md)
- [Transactions categories](https://docs.bridgeapi.io/docs/transactions-categories.md)
- [Connect](https://docs.bridgeapi.io/docs/bridge-connect.md)
- [Account types and user experiences](https://docs.bridgeapi.io/docs/connect-user-journey.md): Depending on your needs, your project may require fetching either all accounts or only payment accounts, offering two distinct experiences for your users
- [Life cycle management](https://docs.bridgeapi.io/docs/strong-customer-authentication-copy.md)
- [Strong Customer Authentication](https://docs.bridgeapi.io/docs/strong-customer-authentication-2025.md)
- [End of the Connect flow](https://docs.bridgeapi.io/docs/end-of-the-connect-flow.md)
- [Test the Bridge Connect](https://docs.bridgeapi.io/docs/test-the-bridge-connect.md)
- [Use the Connect in iframes](https://docs.bridgeapi.io/docs/use-bridge-connect-in-iframes.md)
- [Account list](https://docs.bridgeapi.io/docs/account-list.md): By default, users can choose which accounts they wish to share with you. There are settings to do otherwise.
- [Account Check](https://docs.bridgeapi.io/docs/account-check.md)
- [Your first Account Check](https://docs.bridgeapi.io/docs/your-first-account-check.md)
- [Webhooks](https://docs.bridgeapi.io/docs/webhooks-events.md)
- [Challenge your integration](https://docs.bridgeapi.io/docs/challenge-your-integration.md)
- [Financial Data Aggregation](https://docs.bridgeapi.io/docs/financial-data-aggregation.md)
- [Any other questions ?](https://docs.bridgeapi.io/docs/any-other-questions-copy.md)
- [Presentation](https://docs.bridgeapi.io/docs/presentation_guidance.md)
- [Create your first guidance session from the API](https://docs.bridgeapi.io/docs/create-your-first-guidance-session-from-the-api.md)
- [Manage your guidance session](https://docs.bridgeapi.io/docs/manage-your-guidance-session.md)
- [Manage user consent](https://docs.bridgeapi.io/docs/manage-user-consent.md)
- [Display the guidance in your interface](https://docs.bridgeapi.io/docs/display-the-guidance-in-your-interface.md)
- [Webhook](https://docs.bridgeapi.io/docs/webhook.md)
- [Presentation](https://docs.bridgeapi.io/docs/presentation_payment.md)
- [Create your app](https://docs.bridgeapi.io/docs/payments-create-app.md)
- [Configure](https://docs.bridgeapi.io/docs/configure-payment.md)
- [Customize your app](https://docs.bridgeapi.io/docs/customize.md)
- [Get paid with Bridge](https://docs.bridgeapi.io/docs/get-paid-with-bridge.md)
- [Create your first payment link from the dashboard](https://docs.bridgeapi.io/docs/create-your-first-payment-dashboard.md)
- [Create your first payment link from the API](https://docs.bridgeapi.io/docs/create-your-first-payment-api.md)
- [Create a Payment Link with a dynamic beneficiary](https://docs.bridgeapi.io/docs/create-a-payment-link-dynamic-beneficiary.md)
- [Bulk payment link](https://docs.bridgeapi.io/docs/bulk-payment-link.md)
- [Payment link display](https://docs.bridgeapi.io/docs/payment-link-display.md)
- [Payments statuses](https://docs.bridgeapi.io/docs/payments-statuses-1.md)
- [Payment links statuses](https://docs.bridgeapi.io/docs/payment-links-statuses-1.md)
- [Payment requests and transactions statuses](https://docs.bridgeapi.io/docs/payments-statuses-2.md)
- [Initiate your first payment](https://docs.bridgeapi.io/docs/initiate-your-first-payment-1.md)
- [Payment request endpoint errors](https://docs.bridgeapi.io/docs/payment-request-endpoint-errors-1.md)
- [Create an A2A refund](https://docs.bridgeapi.io/docs/create-a-refund-1.md)
- [Add metadata to your payment requests](https://docs.bridgeapi.io/docs/add-metadata-to-your-payments.md)
- [Bulk payment](https://docs.bridgeapi.io/docs/bulk-payment.md)
- [Payments webhooks](https://docs.bridgeapi.io/docs/payments-webhooks.md)
- [Testing your payment flow](https://docs.bridgeapi.io/docs/testing-your-payment-flow-2.md)
- [Payment account](https://docs.bridgeapi.io/docs/payment-account-2.md)
- [Create your app](https://docs.bridgeapi.io/docs/create-your-app-payment-account.md)
- [Configure](https://docs.bridgeapi.io/docs/configure-payment-account.md)
- [Customize your app](https://docs.bridgeapi.io/docs/customize-your-app-payment-account.md)
- [Get paid with Bridge](https://docs.bridgeapi.io/docs/get-paid-with-bridge-2.md)
- [Create your first payment link from the dashboard](https://docs.bridgeapi.io/docs/first-payment-link-from-the-dashboard.md)
- [Create your first payment link from the API](https://docs.bridgeapi.io/docs/first-payment-link-from-the-api.md)
- [Manual transfer via virtual IBAN](https://docs.bridgeapi.io/docs/reconcile-manual-transfer-via-virtual-iban.md)
- [Payments statuses](https://docs.bridgeapi.io/docs/payments-statuses-3.md)
- [Payment links statuses](https://docs.bridgeapi.io/docs/payment-links-statuses-2.md)
- [Fund information status](https://docs.bridgeapi.io/docs/fund-information-status.md)
- [Payment requests and transactions statuses](https://docs.bridgeapi.io/docs/payment-requests-and-transactions-statuses.md)
- [Payments webhooks](https://docs.bridgeapi.io/docs/payments-account-webhooks.md)
- [Refund your customers from the dashboard](https://docs.bridgeapi.io/docs/refund-your-customers-from-the-dashboard.md)
- [Refund your customers from API](https://docs.bridgeapi.io/docs/refund-your-customers-from-api.md)
- [Payouts from the dashboard](https://docs.bridgeapi.io/docs/payouts-from-the-dashboard.md)
- [Payouts from API](https://docs.bridgeapi.io/docs/payouts-from-the-api.md)
- [Testing your payment flow](https://docs.bridgeapi.io/docs/testing-your-payment-flow.md)
- [Testing the payment account](https://docs.bridgeapi.io/docs/testing-payment-account.md)
- [Testing manual transfer](https://docs.bridgeapi.io/docs/testing-manual-transfer.md)
- [Configure your webhooks](https://docs.bridgeapi.io/docs/webhooks.md): Listen for events on your users accounts and automatically trigger reactions
- [Create production applications by API](https://docs.bridgeapi.io/docs/create-production-applications-by-api.md)

## API Reference
- [Welcome on Bridge API documentation](https://docs.bridgeapi.io/reference/get-started.md)
- [Create a payment link](https://docs.bridgeapi.io/reference/createpaymentlink.md): Create a new payment link
- [List payment links](https://docs.bridgeapi.io/reference/listpaymentlinks.md): Return a list of payment links
- [Get a single payment link](https://docs.bridgeapi.io/reference/getpaymentlink.md): Return a single payment link
- [Revoke payment link](https://docs.bridgeapi.io/reference/revokepaymentlink.md): By using this endpoint you will set the payment link's status to `revoked`. After this, the payment link won't be usable anymore.
- [Create a payment request](https://docs.bridgeapi.io/reference/createpaymentrequest.md): For eligible partners only. Otherwise, use payment link to create a payment.
- [List payment requests](https://docs.bridgeapi.io/reference/getpaymentrequests.md): Return a list of payment requests
- [Get a single payment request](https://docs.bridgeapi.io/reference/getpaymentrequest.md): Retrieve the details of a single payment request
- [Create refund](https://docs.bridgeapi.io/reference/createrefund.md): Create a refund request
- [List refunds](https://docs.bridgeapi.io/reference/listrefunds.md): Return a list of refunds
- [Get a single refund](https://docs.bridgeapi.io/reference/getrefund.md): Get a single refund request
- [List beneficiaries](https://docs.bridgeapi.io/reference/listbeneficiaries.md): Return a list of your beneficiaries
- [Create payout](https://docs.bridgeapi.io/reference/createpayout.md): Create a payout request
- [List payouts](https://docs.bridgeapi.io/reference/listpayouts.md): Return a list of payouts
- [Get a single payout](https://docs.bridgeapi.io/reference/getpayout.md): Get a single payout request
- [Create a payment consent](https://docs.bridgeapi.io/reference/createpaymentconsent.md): For eligible partners only. Create a new payment consent to accept Bridge's ToS
- [List providers](https://docs.bridgeapi.io/reference/getproviders.md): Return a list of supported providers
- [Get a single provider](https://docs.bridgeapi.io/reference/getprovider.md): Retrieve the details of a single supported provider
- [Create a user](https://docs.bridgeapi.io/reference/createuser.md): Create a new user
- [List users](https://docs.bridgeapi.io/reference/listusers.md): Return a list of your users
- [Authorization token](https://docs.bridgeapi.io/reference/createuserauthtoken.md): Create an user authorization token to create connect sessions and fetch banking data for this user
- [Get a single user](https://docs.bridgeapi.io/reference/getuser.md): Return a single user
- [Delete a user](https://docs.bridgeapi.io/reference/deleteuser.md): Delete a user along with all their data (items, accounts and transactions)
- [Create a connect session](https://docs.bridgeapi.io/reference/createconnectsession.md): Connect sessions are front-end sessions that allow your user to connect or update their bank connection
- [Create a user management session](https://docs.bridgeapi.io/reference/createusermanagementsession.md): User management sessions are front-end sessions that allow your users to resolve synchronization issues or add new items for the authenticated user
- [List items](https://docs.bridgeapi.io/reference/getitems.md): Return a list of the user's items
- [Get a single item](https://docs.bridgeapi.io/reference/getitem.md): Retrieve the details of a single item
- [Delete an item](https://docs.bridgeapi.io/reference/deleteitem.md): Delete an item and all its accounts and transactions
- [List accounts](https://docs.bridgeapi.io/reference/getaccounts.md): Return a list of the user's accounts
- [Get a single account](https://docs.bridgeapi.io/reference/getaccount.md): Retrieve the details of a single account
- [List transactions](https://docs.bridgeapi.io/reference/gettransactions.md): Return a list of the user's transactions
- [Get a single transaction](https://docs.bridgeapi.io/reference/gettransaction.md): Retrieve the details of a single transaction
- [Get an attachment download url (need specific scope, see with your CSM)](https://docs.bridgeapi.io/reference/getattachmentdownloadurl.md): Get an URL that allows to download the transaction-related attachment, uploaded by the bank's user
- [List stocks](https://docs.bridgeapi.io/reference/getstocks.md): Return a user's list of provider stocks.
- [Get a single stock](https://docs.bridgeapi.io/reference/getstock.md): Retrieve the details of a single stock
- [List categories](https://docs.bridgeapi.io/reference/getcategories.md): Return the list of supported categories Please contact us to activate this feature
- [Get a single category](https://docs.bridgeapi.io/reference/getcategory.md): Return a single category along with its parent category Please contact us to activate this feature
- [Get insights](https://docs.bridgeapi.io/reference/getinsights.md): Retrieve the insights for each category of a user's transactions
- [Get accounts information](https://docs.bridgeapi.io/reference/getaccountsinformation.md): Fetch IBAN and user's identity Please contact us to activate this feature
- [Create guidance session](https://docs.bridgeapi.io/reference/createguidancesession.md): For eligible partners only. Create a reusable frontend session for the guidance experience.
- [Collect user consent for guidance](https://docs.bridgeapi.io/reference/createguidanceconsent.md): For eligible partners only. Collect user consent for financial guidance services
- [Get guidance for a user](https://docs.bridgeapi.io/reference/getguidancehealth.md): For eligible partners only. Retrieve financial guidance recommendations based on user's transaction analysis. The guidance message is returned in the language selected when the guidance consent was created.
- [Revoke user consent for guidance](https://docs.bridgeapi.io/reference/deleteguidanceconsent.md): For eligible partners only. Permanently delete guidance consent data for the targeted user across all companies.  Warning: this irreversibly deletes guidance analyses, advice, KPIs, and indicator payloads for this user across all companies. It only affects guidance data and does not revoke or delete non-guidance data.
- [Create production applications](https://docs.bridgeapi.io/reference/createapplications.md): For eligible partners only. Create production applications.

## Pages
- [New API version v2021.06.01](https://docs.bridgeapi.io/new-api-version-v20210601.md)