Stripe::FinancialConnectionsApi
Constants
Constructors
Instance methods
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Returns a list of Financial Connections Account objects.
<p>Returns a list of Financial Connections <code>Account</code> objects.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param account_holder [Stripe::AccountholderParams?] If present, only return accounts that belong to the specified account holder. account_holder[customer] and account_holder[account] are mutually exclusive.
@optional @param session [String?] If present, only return accounts that were collected as part of the given session.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the details of an Financial Connections Account.
<p>Retrieves the details of an Financial Connections <code>Account</code>.</p> @required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the details of an Financial Connections <code>Account</code>.</p> @required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialConnectionsAccount, Integer, Hash)] Stripe::FinancialConnectionsAccount, response status code and response headers
<p>Returns a list of Financial Connections <code>Account</code> objects.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param account_holder [Stripe::AccountholderParams?] If present, only return accounts that belong to the specified account holder. account_holder[customer] and account_holder[account] are mutually exclusive.
@optional @param session [String?] If present, only return accounts that were collected as part of the given session.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::BankConnectionsResourceLinkedAccountList, Integer, Hash)] Stripe::BankConnectionsResourceLinkedAccountList, response status code and response headers
Retrieves the details of a Financial Connections Session
<p>Retrieves the details of a Financial Connections <code>Session</code></p> @required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the details of a Financial Connections <code>Session</code></p> @required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialConnectionsSession, Integer, Hash)] Stripe::FinancialConnectionsSession, response status code and response headers
Returns a list of Financial Connections Transaction objects.
<p>Returns a list of Financial Connections <code>Transaction</code> objects.</p>
@required @param account [String?] The ID of the Stripe account whose transactions will be retrieved.
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param transacted_at [Stripe::GetAccountsCreatedParameter?] A filter on the list based on the object transacted_at field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
@optional @param transaction_refresh [Stripe::TransactionRefreshParams?] A filter on the list based on the object transaction_refresh field. The value can be a dictionary with the following options:
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the details of a Financial Connections Transaction
<p>Retrieves the details of a Financial Connections <code>Transaction</code></p> @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the details of a Financial Connections <code>Transaction</code></p> @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialConnectionsTransaction, Integer, Hash)] Stripe::FinancialConnectionsTransaction, response status code and response headers
<p>Returns a list of Financial Connections <code>Transaction</code> objects.</p>
@required @param account [String?] The ID of the Stripe account whose transactions will be retrieved.
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param transacted_at [Stripe::GetAccountsCreatedParameter?] A filter on the list based on the object transacted_at field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
@optional @param transaction_refresh [Stripe::TransactionRefreshParams?] A filter on the list based on the object transaction_refresh field. The value can be a dictionary with the following options:
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::BankConnectionsResourceTransactionList, Integer, Hash)] Stripe::BankConnectionsResourceTransactionList, response status code and response headers
Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
<p>Disables your access to a Financial Connections <code>Account</code>. You will no longer be able to access data associated with the account (e.g. balances, transactions).</p> @required @param account [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Disables your access to a Financial Connections <code>Account</code>. You will no longer be able to access data associated with the account (e.g. balances, transactions).</p> @required @param account [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialConnectionsAccount, Integer, Hash)] Stripe::FinancialConnectionsAccount, response status code and response headers
Refreshes the data associated with a Financial Connections Account.
<p>Refreshes the data associated with a Financial Connections <code>Account</code>.</p> @required @param account [String?] @required @param features [Array(String)?] The list of account features that you would like to refresh. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Refreshes the data associated with a Financial Connections <code>Account</code>.</p> @required @param account [String?] @required @param features [Array(String)?] The list of account features that you would like to refresh. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialConnectionsAccount, Integer, Hash)] Stripe::FinancialConnectionsAccount, response status code and response headers
Subscribes to periodic refreshes of data associated with a Financial Connections Account.
<p>Subscribes to periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p> @required @param account [String?] @required @param features [Array(String)?] The list of account features to which you would like to subscribe. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Subscribes to periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p> @required @param account [String?] @required @param features [Array(String)?] The list of account features to which you would like to subscribe. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialConnectionsAccount, Integer, Hash)] Stripe::FinancialConnectionsAccount, response status code and response headers
Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
<p>Unsubscribes from periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p> @required @param account [String?] @required @param features [Array(String)?] The list of account features from which you would like to unsubscribe. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Unsubscribes from periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p> @required @param account [String?] @required @param features [Array(String)?] The list of account features from which you would like to unsubscribe. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FinancialConnectionsAccount, Integer, Hash)] Stripe::FinancialConnectionsAccount, response status code and response headers
To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
<p>To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js.</p>
@required @param account_holder [Stripe::AccountholderParams?]
@required @param permissions [Array(String)?] List of data features that you would like to request access to. Possible values are balances, transactions, ownership, and payment_method.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param filters [Stripe::FiltersParams?]
@optional @param prefetch [Array(String)?] List of data features that you would like to retrieve upon account creation.
@optional @param return_url [String?] For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
@return nil
<p>To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js.</p>
@required @param account_holder [Stripe::AccountholderParams?]
@required @param permissions [Array(String)?] List of data features that you would like to request access to. Possible values are balances, transactions, ownership, and payment_method.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param filters [Stripe::FiltersParams?]
@optional @param prefetch [Array(String)?] List of data features that you would like to retrieve upon account creation.
@optional @param return_url [String?] For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
@return [Tuple(Stripe::FinancialConnectionsSession, Integer, Hash)] Stripe::FinancialConnectionsSession, response status code and response headers