--- title: Access transactions for a Financial Connections account subtitle: Access an account's transactions with your user's permission. route: /financial-connections/transactions --- # Access transactions for a Financial Connections account Access an account's transactions with your user's permission. The Financial Connections API allows you to retrieve transactions on a [Financial Connections Account](https://docs.stripe.com/api/financial_connections/accounts/object.md). Use transaction data to build a variety of products and solutions, such as: - Expedite the underwriting process and improve access to credit and other financial services for your users. - Mitigate fraud and reduce risk during user onboarding by evaluating a user’s transaction history, and understanding cash inflows and outflows from their financial accounts. - Help your users track expenses, handle bills, and manage their finances. You must have a completed Financial Connections registration to access {{data_type}} in live mode. Check your [Dashboard settings](https://dashboard.stripe.com/settings/financial-connections) to check the state of your registration or begin the registration process. Financial Connections test data is always available. ## Create a customer We recommend that you create a *Customer* with an email address to represent your user, that you then attach to your payment. Attaching a Customer object allows you to [list previously linked accounts ](https://docs.stripe.com/api/financial_connections/accounts/list.md) later. By providing an email address on the Customer object, Financial Connections can improve the authentication flow by streamlining sign-in or sign-up for your user, depending on whether they’re a returning [Link](https://support.stripe.com/questions/link-for-financial-connections-support-for-businesses) user. ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new CustomerCreateOptions { Email = "{{CUSTOMER_EMAIL}}" }; var service = new CustomerService(); Customer customer = service.Create(options); ``` ```go stripe.Key = "<>" params := &stripe.CustomerParams{Email: stripe.String("{{CUSTOMER_EMAIL}}")}; result, err := customer.New(params); ``` ```java Stripe.apiKey = "<>"; CustomerCreateParams params = CustomerCreateParams.builder().setEmail("{{CUSTOMER_EMAIL}}").build(); Customer customer = Customer.create(params); ``` ```node const stripe = require('stripe')('<>'); const customer = await stripe.customers.create({ email: '{{CUSTOMER_EMAIL}}', }); ``` ```python import stripe stripe.api_key = "<>" customer = stripe.Customer.create(email="{{CUSTOMER_EMAIL}}") ``` ```php $stripe = new \Stripe\StripeClient('<>'); $customer = $stripe->customers->create(['email' => '{{CUSTOMER_EMAIL}}']); ``` ```ruby Stripe.api_key = '<>' customer = Stripe::Customer.create({email: '{{CUSTOMER_EMAIL}}'}) ``` ## Request access to an account's transactions You must collect an account before you can access its transaction data. To learn more about how to collect Financial Connections Accounts consult the integration guide most relevant to your use case: [accept payments](https://docs.stripe.com/financial-connections/ach-direct-debit-payments.md), [facilitate Connect payouts](https://docs.stripe.com/financial-connections/connect-payouts.md), or [build other-data powered products](https://docs.stripe.com/financial-connections/other-data-powered-products.md). When collecting an account, you specify the data you need access to with the [permissions](https://docs.stripe.com/financial-connections/fundamentals.md#data-permissions) parameter. The set of requested data permissions are viewable by the user in the [authentication flow](https://docs.stripe.com/financial-connections/fundamentals.md#authentication-flow). Financial Connections Accounts are collectible through various integration paths, and how you specify the parameter varies slightly by API. ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new PaymentIntentCreateOptions { Amount = 20000, Currency = "usd", Customer = "<>", PaymentMethodTypes = new List { "us_bank_account" }, PaymentMethodOptions = new PaymentIntentPaymentMethodOptionsOptions { UsBankAccount = new PaymentIntentPaymentMethodOptionsUsBankAccountOptions { FinancialConnections = new PaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions { Permissions = new List { "transactions", "payment_method" }, }, }, }, }; var service = new PaymentIntentService(); PaymentIntent paymentIntent = service.Create(options); ``` ```go stripe.Key = "<>" params := &stripe.PaymentIntentParams{ Amount: stripe.Int64(20000), Currency: stripe.String(string(stripe.CurrencyUSD)), Customer: stripe.String("<>"), PaymentMethodTypes: []*string{stripe.String("us_bank_account")}, PaymentMethodOptions: &stripe.PaymentIntentPaymentMethodOptionsParams{ USBankAccount: &stripe.PaymentIntentPaymentMethodOptionsUSBankAccountParams{ FinancialConnections: &stripe.PaymentIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsParams{ Permissions: []*string{ stripe.String(string(stripe.PaymentIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionTransactions)), stripe.String(string(stripe.PaymentIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionPaymentMethod)), }, }, }, }, }; result, err := paymentintent.New(params); ``` ```java Stripe.apiKey = "<>"; PaymentIntentCreateParams params = PaymentIntentCreateParams.builder() .setAmount(20000L) .setCurrency("usd") .setCustomer("<>") .addPaymentMethodType("us_bank_account") .setPaymentMethodOptions( PaymentIntentCreateParams.PaymentMethodOptions.builder() .setUsBankAccount( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.builder() .setFinancialConnections( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.builder() .addPermission( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.TRANSACTIONS ) .addPermission( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.PAYMENT_METHOD ) .build() ) .build() ) .build() ) .build(); PaymentIntent paymentIntent = PaymentIntent.create(params); ``` ```node const stripe = require('stripe')('<>'); const paymentIntent = await stripe.paymentIntents.create({ amount: 20000, currency: 'usd', customer: '<>', payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: { financial_connections: { permissions: ['transactions', 'payment_method'], }, }, }, }); ``` ```python import stripe stripe.api_key = "<>" payment_intent = stripe.PaymentIntent.create( amount=20000, currency="usd", customer="<>", payment_method_types=["us_bank_account"], payment_method_options={ "us_bank_account": { "financial_connections": {"permissions": ["transactions", "payment_method"]}, }, }, ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $paymentIntent = $stripe->paymentIntents->create([ 'amount' => 20000, 'currency' => 'usd', 'customer' => '<>', 'payment_method_types' => ['us_bank_account'], 'payment_method_options' => [ 'us_bank_account' => [ 'financial_connections' => ['permissions' => ['transactions', 'payment_method']], ], ], ]); ``` ```ruby Stripe.api_key = '<>' payment_intent = Stripe::PaymentIntent.create({ amount: 20000, currency: 'usd', customer: '<>', payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: {financial_connections: {permissions: ['transactions', 'payment_method']}}, }, }) ``` ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new SetupIntentCreateOptions { Customer = "<>", PaymentMethodTypes = new List { "us_bank_account" }, PaymentMethodOptions = new SetupIntentPaymentMethodOptionsOptions { UsBankAccount = new SetupIntentPaymentMethodOptionsUsBankAccountOptions { FinancialConnections = new SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions { Permissions = new List { "transactions", "payment_method" }, }, }, }, }; var service = new SetupIntentService(); SetupIntent setupIntent = service.Create(options); ``` ```go stripe.Key = "<>" params := &stripe.SetupIntentParams{ Customer: stripe.String("<>"), PaymentMethodTypes: []*string{stripe.String("us_bank_account")}, PaymentMethodOptions: &stripe.SetupIntentPaymentMethodOptionsParams{ USBankAccount: &stripe.SetupIntentPaymentMethodOptionsUSBankAccountParams{ FinancialConnections: &stripe.SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsParams{ Permissions: []*string{ stripe.String(string(stripe.SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionTransactions)), stripe.String(string(stripe.SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionPaymentMethod)), }, }, }, }, }; result, err := setupintent.New(params); ``` ```java Stripe.apiKey = "<>"; SetupIntentCreateParams params = SetupIntentCreateParams.builder() .setCustomer("<>") .addPaymentMethodType("us_bank_account") .setPaymentMethodOptions( SetupIntentCreateParams.PaymentMethodOptions.builder() .setUsBankAccount( SetupIntentCreateParams.PaymentMethodOptions.UsBankAccount.builder() .setFinancialConnections( SetupIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.builder() .addPermission( SetupIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.TRANSACTIONS ) .addPermission( SetupIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.PAYMENT_METHOD ) .build() ) .build() ) .build() ) .build(); SetupIntent setupIntent = SetupIntent.create(params); ``` ```node const stripe = require('stripe')('<>'); const setupIntent = await stripe.setupIntents.create({ customer: '<>', payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: { financial_connections: { permissions: ['transactions', 'payment_method'], }, }, }, }); ``` ```python import stripe stripe.api_key = "<>" setup_intent = stripe.SetupIntent.create( customer="<>", payment_method_types=["us_bank_account"], payment_method_options={ "us_bank_account": { "financial_connections": {"permissions": ["transactions", "payment_method"]}, }, }, ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $setupIntent = $stripe->setupIntents->create([ 'customer' => '<>', 'payment_method_types' => ['us_bank_account'], 'payment_method_options' => [ 'us_bank_account' => [ 'financial_connections' => ['permissions' => ['transactions', 'payment_method']], ], ], ]); ``` ```ruby Stripe.api_key = '<>' setup_intent = Stripe::SetupIntent.create({ customer: '<>', payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: {financial_connections: {permissions: ['transactions', 'payment_method']}}, }, }) ``` ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new Stripe.FinancialConnections.SessionCreateOptions { AccountHolder = new Stripe.FinancialConnections.SessionAccountHolderOptions { Type = "customer", Customer = "<>", }, Permissions = new List { "transactions" }, }; var service = new Stripe.FinancialConnections.SessionService(); Stripe.FinancialConnections.Session session = service.Create(options); ``` ```go stripe.Key = "<>" params := &stripe.FinancialConnectionsSessionParams{ AccountHolder: &stripe.FinancialConnectionsSessionAccountHolderParams{ Type: stripe.String(string(stripe.FinancialConnectionsSessionAccountHolderTypeCustomer)), Customer: stripe.String("<>"), }, Permissions: []*string{ stripe.String(string(stripe.FinancialConnectionsSessionPermissionTransactions)), }, }; result, err := session.New(params); ``` ```java Stripe.apiKey = "<>"; SessionCreateParams params = SessionCreateParams.builder() .setAccountHolder( SessionCreateParams.AccountHolder.builder() .setType(SessionCreateParams.AccountHolder.Type.CUSTOMER) .setCustomer("<>") .build() ) .addPermission(SessionCreateParams.Permission.TRANSACTIONS) .build(); Session session = Session.create(params); ``` ```node const stripe = require('stripe')('<>'); const session = await stripe.financialConnections.sessions.create({ account_holder: { type: 'customer', customer: '<>', }, permissions: ['transactions'], }); ``` ```python import stripe stripe.api_key = "<>" session = stripe.financial_connections.Session.create( account_holder={"type": "customer", "customer": "<>"}, permissions=["transactions"], ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $session = $stripe->financialConnections->sessions->create([ 'account_holder' => [ 'type' => 'customer', 'customer' => '<>', ], 'permissions' => ['transactions'], ]); ``` ```ruby Stripe.api_key = '<>' session = Stripe::FinancialConnections::Session.create({ account_holder: { type: 'customer', customer: '<>', }, permissions: ['transactions'], }) ``` ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new Stripe.Checkout.SessionCreateOptions { Customer = "<>", PaymentMethodTypes = new List { "us_bank_account" }, PaymentMethodOptions = new Stripe.Checkout.SessionPaymentMethodOptionsOptions { UsBankAccount = new Stripe.Checkout.SessionPaymentMethodOptionsUsBankAccountOptions { FinancialConnections = new Stripe.Checkout.SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions { Permissions = new List { "transactions", "payment_method" }, }, }, }, }; var service = new Stripe.Checkout.SessionService(); Stripe.Checkout.Session session = service.Create(options); ``` ```go stripe.Key = "<>" params := &stripe.CheckoutSessionParams{ Customer: stripe.String("<>"), PaymentMethodTypes: []*string{stripe.String("us_bank_account")}, PaymentMethodOptions: &stripe.CheckoutSessionPaymentMethodOptionsParams{ USBankAccount: &stripe.CheckoutSessionPaymentMethodOptionsUSBankAccountParams{ FinancialConnections: &stripe.CheckoutSessionPaymentMethodOptionsUSBankAccountFinancialConnectionsParams{ Permissions: []*string{ stripe.String(string(stripe.CheckoutSessionPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionTransactions)), stripe.String(string(stripe.CheckoutSessionPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionPaymentMethod)), }, }, }, }, }; result, err := session.New(params); ``` ```java Stripe.apiKey = "<>"; SessionCreateParams params = SessionCreateParams.builder() .setCustomer("<>") .addPaymentMethodType(SessionCreateParams.PaymentMethodType.US_BANK_ACCOUNT) .setPaymentMethodOptions( SessionCreateParams.PaymentMethodOptions.builder() .setUsBankAccount( SessionCreateParams.PaymentMethodOptions.UsBankAccount.builder() .setFinancialConnections( SessionCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.builder() .addPermission( SessionCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.TRANSACTIONS ) .addPermission( SessionCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.PAYMENT_METHOD ) .build() ) .build() ) .build() ) .build(); Session session = Session.create(params); ``` ```node const stripe = require('stripe')('<>'); const session = await stripe.checkout.sessions.create({ customer: '<>', payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: { financial_connections: { permissions: ['transactions', 'payment_method'], }, }, }, }); ``` ```python import stripe stripe.api_key = "<>" session = stripe.checkout.Session.create( customer="<>", payment_method_types=["us_bank_account"], payment_method_options={ "us_bank_account": { "financial_connections": {"permissions": ["transactions", "payment_method"]}, }, }, ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $session = $stripe->checkout->sessions->create([ 'customer' => '<>', 'payment_method_types' => ['us_bank_account'], 'payment_method_options' => [ 'us_bank_account' => [ 'financial_connections' => ['permissions' => ['transactions', 'payment_method']], ], ], ]); ``` ```ruby Stripe.api_key = '<>' session = Stripe::Checkout::Session.create({ customer: '<>', payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: {financial_connections: {permissions: ['transactions', 'payment_method']}}, }, }) ``` ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new InvoiceCreateOptions { Customer = "<>", PaymentSettings = new InvoicePaymentSettingsOptions { PaymentMethodTypes = new List { "us_bank_account" }, PaymentMethodOptions = new InvoicePaymentSettingsPaymentMethodOptionsOptions { UsBankAccount = new InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountOptions { FinancialConnections = new InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions { Permissions = new List { "transactions", "payment_method" }, }, }, }, }, }; var service = new InvoiceService(); Invoice invoice = service.Create(options); ``` ```go stripe.Key = "<>" params := &stripe.InvoiceParams{ Customer: stripe.String("<>"), PaymentSettings: &stripe.InvoicePaymentSettingsParams{ PaymentMethodTypes: []*string{ stripe.String(string(stripe.InvoicePaymentSettingsPaymentMethodTypeUSBankAccount)), }, PaymentMethodOptions: &stripe.InvoicePaymentSettingsPaymentMethodOptionsParams{ USBankAccount: &stripe.InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountParams{ FinancialConnections: &stripe.InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsParams{ Permissions: []*string{ stripe.String(string(stripe.InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionTransactions)), stripe.String(string(stripe.InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionPaymentMethod)), }, }, }, }, }, }; result, err := invoice.New(params); ``` ```java Stripe.apiKey = "<>"; InvoiceCreateParams params = InvoiceCreateParams.builder() .setCustomer("<>") .setPaymentSettings( InvoiceCreateParams.PaymentSettings.builder() .addPaymentMethodType(InvoiceCreateParams.PaymentSettings.PaymentMethodType.US_BANK_ACCOUNT) .setPaymentMethodOptions( InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.builder() .setUsBankAccount( InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.builder() .setFinancialConnections( InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.builder() .addPermission( InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.TRANSACTIONS ) .addPermission( InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.PAYMENT_METHOD ) .build() ) .build() ) .build() ) .build() ) .build(); Invoice invoice = Invoice.create(params); ``` ```node const stripe = require('stripe')('<>'); const invoice = await stripe.invoices.create({ customer: '<>', payment_settings: { payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: { financial_connections: { permissions: ['transactions', 'payment_method'], }, }, }, }, }); ``` ```python import stripe stripe.api_key = "<>" invoice = stripe.Invoice.create( customer="<>", payment_settings={ "payment_method_types": ["us_bank_account"], "payment_method_options": { "us_bank_account": { "financial_connections": {"permissions": ["transactions", "payment_method"]}, }, }, }, ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $invoice = $stripe->invoices->create([ 'customer' => '<>', 'payment_settings' => [ 'payment_method_types' => ['us_bank_account'], 'payment_method_options' => [ 'us_bank_account' => [ 'financial_connections' => ['permissions' => ['transactions', 'payment_method']], ], ], ], ]); ``` ```ruby Stripe.api_key = '<>' invoice = Stripe::Invoice.create({ customer: '<>', payment_settings: { payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: {financial_connections: {permissions: ['transactions', 'payment_method']}}, }, }, }) ``` ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new SubscriptionCreateOptions { Customer = "{{CUSTOMER_ID}}", PaymentSettings = new SubscriptionPaymentSettingsOptions { PaymentMethodTypes = new List { "us_bank_account" }, PaymentMethodOptions = new SubscriptionPaymentSettingsPaymentMethodOptionsOptions { UsBankAccount = new SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountOptions { FinancialConnections = new SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions { Permissions = new List { "transactions", "payment_method" }, }, }, }, }, }; var service = new SubscriptionService(); Subscription subscription = service.Create(options); ``` ```go stripe.Key = "<>" params := &stripe.SubscriptionParams{ Customer: stripe.String("{{CUSTOMER_ID}}"), PaymentSettings: &stripe.SubscriptionPaymentSettingsParams{ PaymentMethodTypes: []*string{ stripe.String(string(stripe.SubscriptionPaymentSettingsPaymentMethodTypeUSBankAccount)), }, PaymentMethodOptions: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsParams{ USBankAccount: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUSBankAccountParams{ FinancialConnections: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsParams{ Permissions: []*string{ stripe.String(string(stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionTransactions)), stripe.String(string(stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionPaymentMethod)), }, }, }, }, }, }; result, err := subscription.New(params); ``` ```java Stripe.apiKey = "<>"; SubscriptionCreateParams params = SubscriptionCreateParams.builder() .setCustomer("{{CUSTOMER_ID}}") .setPaymentSettings( SubscriptionCreateParams.PaymentSettings.builder() .addPaymentMethodType( SubscriptionCreateParams.PaymentSettings.PaymentMethodType.US_BANK_ACCOUNT ) .setPaymentMethodOptions( SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.builder() .setUsBankAccount( SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.builder() .setFinancialConnections( SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.builder() .addPermission( SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.TRANSACTIONS ) .addPermission( SubscriptionCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.PAYMENT_METHOD ) .build() ) .build() ) .build() ) .build() ) .build(); Subscription subscription = Subscription.create(params); ``` ```node const stripe = require('stripe')('<>'); const subscription = await stripe.subscriptions.create({ customer: '{{CUSTOMER_ID}}', payment_settings: { payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: { financial_connections: { permissions: ['transactions', 'payment_method'], }, }, }, }, }); ``` ```python import stripe stripe.api_key = "<>" subscription = stripe.Subscription.create( customer="{{CUSTOMER_ID}}", payment_settings={ "payment_method_types": ["us_bank_account"], "payment_method_options": { "us_bank_account": { "financial_connections": {"permissions": ["transactions", "payment_method"]}, }, }, }, ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $subscription = $stripe->subscriptions->create([ 'customer' => '{{CUSTOMER_ID}}', 'payment_settings' => [ 'payment_method_types' => ['us_bank_account'], 'payment_method_options' => [ 'us_bank_account' => [ 'financial_connections' => ['permissions' => ['transactions', 'payment_method']], ], ], ], ]); ``` ```ruby Stripe.api_key = '<>' subscription = Stripe::Subscription.create({ customer: '{{CUSTOMER_ID}}', payment_settings: { payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: {financial_connections: {permissions: ['transactions', 'payment_method']}}, }, }, }) ``` When using dynamic payment methods for certain payments APIs, you can also configure requested permissions in the Dashboard. Learn how to [access additional account data on Financial Connections accounts](https://docs.stripe.com/financial-connections/ach-direct-debit-payments.md?dashboard-or-api=dashboard#access). ## Subscribe to transaction data When you subscribe to an account’s transaction data, Stripe automatically retrieves new transactions in the background every day and notifies you when they’re available. Subscribing to daily updates is the easiest way to keep the account’s transaction data up to date. To get the Financial Connections Account ID you want to subscribe to transactions for, consult the documentation for our [payments integrations](https://docs.stripe.com/financial-connections/ach-direct-debit-payments.md#finding-the-financial-connections-account-id) or check the guide for [Financial Connections Sessions](https://docs.stripe.com/financial-connections/other-data-powered-products.md?platform=web#collect-an-account). Subscribe to transaction data by calling the [subscribe API](https://docs.stripe.com/api/financial_connections/accounts/subscribe.md): ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new Stripe.FinancialConnections.AccountSubscribeOptions { Features = new List { "transactions" }, }; var service = new Stripe.FinancialConnections.AccountService(); Stripe.FinancialConnections.Account account = service.Subscribe( "<>", options); ``` ```go stripe.Key = "<>" params := &stripe.FinancialConnectionsAccountSubscribeParams{ Features: []*string{stripe.String("transactions")}, }; result, err := account.Subscribe("<>", params); ``` ```java Stripe.apiKey = "<>"; Account resource = Account.retrieve("<>"); AccountSubscribeParams params = AccountSubscribeParams.builder().addFeature(AccountSubscribeParams.Feature.TRANSACTIONS).build(); Account account = resource.subscribe(params); ``` ```node const stripe = require('stripe')('<>'); const account = await stripe.financialConnections.accounts.subscribe( '<>', { features: ['transactions'], } ); ``` ```python import stripe stripe.api_key = "<>" account = stripe.financial_connections.Account.subscribe( "<>", features=["transactions"], ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $account = $stripe->financialConnections->accounts->subscribe( '<>', ['features' => ['transactions']] ); ``` ```ruby Stripe.api_key = '<>' account = Stripe::FinancialConnections::Account.subscribe( '<>', {features: ['transactions']}, ) ``` In addition to activating a subscription to future transaction data, this API call automatically initiates a transaction refresh: ```json { "id": "fca_1LDYuMGxLVUXRs6HW0lrat9T", "object": "financial_connections.account", "display_name": "Savings", "institution_name": "Test Bank", "status": "active", "permissions": ["transactions"], "subscriptions": ["transactions"], "transaction_refresh": { "id": "fctxnref_1aaaxqEitUZY8Svm4QdcWZKt", "last_attempted_at": 1706742786, "next_refresh_available_at": null, "status": "pending" } // ... } ``` As long as you remain subscribed to transaction data, Stripe initiates a new refresh every day. ### Wait for the refresh to complete All Financial Connections data refreshes are asynchronous. After you initiate a transaction refresh, you must wait for it to complete, then retrieve the resulting transactions. The [transaction_refresh](https://docs.stripe.com/api/financial_connections/accounts/object.md#financial_connections_account_object-transaction_refresh) field on a Financial Connections account represents the transaction refresh state. This field remains `null` until you request the `transactions` permission and initiate a refresh. After you start a transaction refresh, the state changes to `pending`, and after completion, it moves to either `succeeded` or `failed`. We send the [financial_connections.account.refreshed_transactions](https://docs.stripe.com/api/events/types.md#event_types-financial_connections.account.refreshed_transactions) event when the transaction refresh completes. To determine the success of the refresh, check the `transaction_refresh.status` field while handling the webhook. ## Retrieve transactions After Stripe successfully refreshes transactions on the account, you can retrieve them using the [transactions list API](https://docs.stripe.com/api/financial_connections/transactions/list.md): ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new Stripe.FinancialConnections.TransactionListOptions { Account = "<>", }; var service = new Stripe.FinancialConnections.TransactionService(); StripeList transactions = service.List(options); ``` ```go stripe.Key = "<>" params := &stripe.FinancialConnectionsTransactionListParams{ Account: stripe.String("<>"), }; result := transaction.List(params); ``` ```java Stripe.apiKey = "<>"; TransactionListParams params = TransactionListParams.builder().setAccount("<>").build(); TransactionCollection transactions = Transaction.list(params); ``` ```node const stripe = require('stripe')('<>'); const transactions = await stripe.financialConnections.transactions.list({ account: '<>', }); ``` ```python import stripe stripe.api_key = "<>" transactions = stripe.financial_connections.Transaction.list( account="<>", ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $transactions = $stripe->financialConnections->transactions->all([ 'account' => '<>', ]); ``` ```ruby Stripe.api_key = '<>' transactions = Stripe::FinancialConnections::Transaction.list({ account: '<>', }) ``` Stripe returns a [paginated](https://docs.stripe.com/api/pagination.md) list of up to the last 180 days of transaction history on an account, depending on the account’s financial institution. ```json { "object": "list", "data": [ { "id": "fctxn_1LXp9RGxLVUXRs6HtTSVfxse", "object": "financial_connections.transaction", "account": "fca_1LDYuMGxLVUXRs6HW0lrat9T", "amount": -1000, "currency": "usd", "description": "Rocket Rides", "livemode": true, "status": "posted", "status_transitions": { "posted_at": 1651784999, "void_at": null }, "transacted_at": 1651784999, "transaction_refresh": "fctxnref_1LXp8WGxLVUXRs6Hkc5PNUXf", "updated": 1651784999 }, {...}, {...} ], "has_more": false, "url": "/v1/financial_connections/transactions" } ``` The [status](https://docs.stripe.com/api/financial_connections/transactions/object.md#financial_connections_transaction_object-status) of a transaction is one of `pending`, `posted`, or `void`. Information included in the [description](https://docs.stripe.com/api/financial_connections/transactions/object.md#financial_connections_transaction_object-description) field varies, but can include metadata such as the business name. ### Retrieving transactions since last refresh You might wish to retrieve only new transaction data since your last data pull. For example, some users save previously retrieved transaction data to their database, and subsequently merge new or updated data as it becomes available. To retrieve only new or updated transaction data since your last refresh, pass the `transaction_refresh` identifier provided by your last observed [financial_connections.account.refreshed_transactions](https://docs.stripe.com/api/events/types.md#event_types-financial_connections.account.refreshed_transactions) webhook event object to the list API: ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new Stripe.FinancialConnections.TransactionListOptions { Account = "<>", TransactionRefresh = new Stripe.FinancialConnections.TransactionTransactionRefreshOptions { After = "fctxnref_1LXp8WGxLVUXRs6Hkc5PNUXf", }, }; var service = new Stripe.FinancialConnections.TransactionService(); StripeList transactions = service.List(options); ``` ```go stripe.Key = "<>" params := &stripe.FinancialConnectionsTransactionListParams{ Account: stripe.String("<>"), TransactionRefresh: &stripe.FinancialConnectionsTransactionListTransactionRefreshParams{ After: stripe.String("fctxnref_1LXp8WGxLVUXRs6Hkc5PNUXf"), }, }; result := transaction.List(params); ``` ```java Stripe.apiKey = "<>"; TransactionListParams params = TransactionListParams.builder() .setAccount("<>") .setTransactionRefresh( TransactionListParams.TransactionRefresh.builder() .setAfter("fctxnref_1LXp8WGxLVUXRs6Hkc5PNUXf") .build() ) .build(); TransactionCollection transactions = Transaction.list(params); ``` ```node const stripe = require('stripe')('<>'); const transactions = await stripe.financialConnections.transactions.list({ account: '<>', transaction_refresh: { after: 'fctxnref_1LXp8WGxLVUXRs6Hkc5PNUXf', }, }); ``` ```python import stripe stripe.api_key = "<>" transactions = stripe.financial_connections.Transaction.list( account="<>", transaction_refresh={"after": "fctxnref_1LXp8WGxLVUXRs6Hkc5PNUXf"}, ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $transactions = $stripe->financialConnections->transactions->all([ 'account' => '<>', 'transaction_refresh' => ['after' => 'fctxnref_1LXp8WGxLVUXRs6Hkc5PNUXf'], ]); ``` ```ruby Stripe.api_key = '<>' transactions = Stripe::FinancialConnections::Transaction.list({ account: '<>', transaction_refresh: {after: 'fctxnref_1LXp8WGxLVUXRs6Hkc5PNUXf'}, }) ``` The following is an example [webhook](https://docs.stripe.com/webhooks.md#webhook-endpoint-def) integration that only retrieves and records new or updated transaction data: ```python import stripe from flask import Flask app = Flask(__name__) @app.route('/stripe_webhooks', methods=['POST']) def webhook(): event = None try: event = stripe.Event.construct_from(json.loads(request.data), stripe.api_key) except ValueError as e: # Invalid payload raise e if event.type == "financial_connections.account.refreshed_transactions": account = event.data.object sync_transactions(account["id"], account["transaction_refresh"]["id"]) return jsonify(success=True) def sync_transactions(account_id, current_refresh): # Fetches the last transaction_refresh observed for this account from internal database last_observed_transaction_refresh = get_previous_transaction_refresh(key=account_id) # Get transactions since the last seen transaction_refresh response = stripe.financial_connections.Transaction.list( account=account_id, transaction_refresh={"after": last_observed_transaction_refresh}, ) # We know every transaction is either new or updated because of the `transaction_refresh` filter in the list endpoint for transaction in response.data: record_transaction(transaction) # Saves the transaction to the DB # Updates the last observed transaction_refresh for this account to the current refresh set_previous_transaction_refresh(key=account_id, value=current_refresh) ``` ## Unsubscribe from transaction data You can start, cancel, and resume a subscription at any point. To cancel a subscription, call the [unsubscribe API](https://docs.stripe.com/api/financial_connections/accounts/unsubscribe.md): ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new Stripe.FinancialConnections.AccountUnsubscribeOptions { Features = new List { "transactions" }, }; var service = new Stripe.FinancialConnections.AccountService(); Stripe.FinancialConnections.Account account = service.Unsubscribe( "<>", options); ``` ```go stripe.Key = "<>" params := &stripe.FinancialConnectionsAccountUnsubscribeParams{ Features: []*string{stripe.String("transactions")}, }; result, err := account.Unsubscribe("<>", params); ``` ```java Stripe.apiKey = "<>"; Account resource = Account.retrieve("<>"); AccountUnsubscribeParams params = AccountUnsubscribeParams.builder() .addFeature(AccountUnsubscribeParams.Feature.TRANSACTIONS) .build(); Account account = resource.unsubscribe(params); ``` ```node const stripe = require('stripe')('<>'); const account = await stripe.financialConnections.accounts.unsubscribe( '<>', { features: ['transactions'], } ); ``` ```python import stripe stripe.api_key = "<>" account = stripe.financial_connections.Account.unsubscribe( "<>", features=["transactions"], ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $account = $stripe->financialConnections->accounts->unsubscribe( '<>', ['features' => ['transactions']] ); ``` ```ruby Stripe.api_key = '<>' account = Stripe::FinancialConnections::Account.unsubscribe( '<>', {features: ['transactions']}, ) ``` To resume the subscription, call the [subscribe API](https://docs.stripe.com/api/financial_connections/accounts/subscribe.md) again. ## Refresh transactions on demand There are two alternatives to [subscribing](#subscribe-to-transactions) to daily updates: prefetching transaction data and on-demand refreshes. You might use these methods if you only want a one-time transaction data pull for a use case like underwriting. These methods are not mutually exclusive with maintaining a subscription, but most financial institutions don’t update transactions multiple times per day. ### Prefetch transaction data Specify whether you want to prefetch account transactions _before_ account collection. This initiates the refresh process as soon as your user connects their account in the [authentication flow](https://docs.stripe.com/financial-connections/fundamentals.md#authentication-flow). Set `prefetch` when you require transaction data for every linked account, to make sure you receive it with minimal delay. The `prefetch` parameter is available on all APIs that support Financial Connections. ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new PaymentIntentCreateOptions { Amount = 20000, Currency = "usd", PaymentMethodTypes = new List { "us_bank_account" }, PaymentMethodOptions = new PaymentIntentPaymentMethodOptionsOptions { UsBankAccount = new PaymentIntentPaymentMethodOptionsUsBankAccountOptions { FinancialConnections = new PaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions { Prefetch = new List { "transactions" }, Permissions = new List { "payment_method", "transactions" }, }, }, }, }; var service = new PaymentIntentService(); PaymentIntent paymentIntent = service.Create(options); ``` ```go stripe.Key = "<>" params := &stripe.PaymentIntentParams{ Amount: stripe.Int64(20000), Currency: stripe.String(string(stripe.CurrencyUSD)), PaymentMethodTypes: []*string{stripe.String("us_bank_account")}, PaymentMethodOptions: &stripe.PaymentIntentPaymentMethodOptionsParams{ USBankAccount: &stripe.PaymentIntentPaymentMethodOptionsUSBankAccountParams{ FinancialConnections: &stripe.PaymentIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsParams{ Prefetch: []*string{ stripe.String(string(stripe.PaymentIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchTransactions)), }, Permissions: []*string{ stripe.String(string(stripe.PaymentIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionPaymentMethod)), stripe.String(string(stripe.PaymentIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionTransactions)), }, }, }, }, }; result, err := paymentintent.New(params); ``` ```java Stripe.apiKey = "<>"; PaymentIntentCreateParams params = PaymentIntentCreateParams.builder() .setAmount(20000L) .setCurrency("usd") .addPaymentMethodType("us_bank_account") .setPaymentMethodOptions( PaymentIntentCreateParams.PaymentMethodOptions.builder() .setUsBankAccount( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.builder() .setFinancialConnections( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.builder() .addPrefetch( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Prefetch.TRANSACTIONS ) .addPermission( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.PAYMENT_METHOD ) .addPermission( PaymentIntentCreateParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.Permission.TRANSACTIONS ) .build() ) .build() ) .build() ) .build(); PaymentIntent paymentIntent = PaymentIntent.create(params); ``` ```node const stripe = require('stripe')('<>'); const paymentIntent = await stripe.paymentIntents.create({ amount: 20000, currency: 'usd', payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: { financial_connections: { prefetch: ['transactions'], permissions: ['payment_method', 'transactions'], }, }, }, }); ``` ```python import stripe stripe.api_key = "<>" payment_intent = stripe.PaymentIntent.create( amount=20000, currency="usd", payment_method_types=["us_bank_account"], payment_method_options={ "us_bank_account": { "financial_connections": { "prefetch": ["transactions"], "permissions": ["payment_method", "transactions"], }, }, }, ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $paymentIntent = $stripe->paymentIntents->create([ 'amount' => 20000, 'currency' => 'usd', 'payment_method_types' => ['us_bank_account'], 'payment_method_options' => [ 'us_bank_account' => [ 'financial_connections' => [ 'prefetch' => ['transactions'], 'permissions' => ['payment_method', 'transactions'], ], ], ], ]); ``` ```ruby Stripe.api_key = '<>' payment_intent = Stripe::PaymentIntent.create({ amount: 20000, currency: 'usd', payment_method_types: ['us_bank_account'], payment_method_options: { us_bank_account: { financial_connections: { prefetch: ['transactions'], permissions: ['payment_method', 'transactions'], }, }, }, }) ``` After initiating a transaction refresh using `prefetch`, [wait for it to complete](#wait-for-completion). ### Initiate an on-demand refresh Use the [Refresh API](https://docs.stripe.com/api/financial_connections/accounts/refresh.md) to initiate on-demand transaction refreshes _after_ account collection, and fetch transaction information for a specific account at your convenience, allowing you to defer the decision until a later time. ```dotnet StripeConfiguration.ApiKey = "<>"; var options = new Stripe.FinancialConnections.AccountRefreshOptions { Features = new List { "transactions" }, }; var service = new Stripe.FinancialConnections.AccountService(); Stripe.FinancialConnections.Account account = service.Refresh( "<>", options); ``` ```go stripe.Key = "<>" params := &stripe.FinancialConnectionsAccountRefreshParams{ Features: []*string{stripe.String("transactions")}, }; result, err := account.Refresh("<>", params); ``` ```java Stripe.apiKey = "<>"; Account resource = Account.retrieve("<>"); AccountRefreshParams params = AccountRefreshParams.builder().addFeature(AccountRefreshParams.Feature.TRANSACTIONS).build(); Account account = resource.refresh(params); ``` ```node const stripe = require('stripe')('<>'); const account = await stripe.financialConnections.accounts.refresh( '<>', { features: ['transactions'], } ); ``` ```python import stripe stripe.api_key = "<>" account = stripe.financial_connections.Account.refresh_account( "<>", features=["transactions"], ) ``` ```php $stripe = new \Stripe\StripeClient('<>'); $account = $stripe->financialConnections->accounts->refresh( '<>', ['features' => ['transactions']] ); ``` ```ruby Stripe.api_key = '<>' account = Stripe::FinancialConnections::Account.refresh_account( '<>', {features: ['transactions']}, ) ``` After initiating a transaction refresh using the Refresh API, [wait for it to complete](#wait-for-completion). After a transaction refresh completes, Stripe sets the availability of future refreshes through the [transaction_refresh.next_refresh_available_at](https://docs.stripe.com/api/financial_connections/accounts/object.md#financial_connections_account_object-transaction_refresh-next_refresh_available_at) field.