class Stripe::FinancialConnectionsApi
- Stripe::FinancialConnectionsApi
- Reference
- Object
Defined in:
stripe/api/financial_connections_api.crConstant Summary
-
GET_FINANCIAL_CONNECTIONS_ACCOUNTS_ACCOUNT_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_FINANCIAL_CONNECTIONS_ACCOUNTS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_FINANCIAL_CONNECTIONS_ACCOUNTS_MAX_LENGTH_FOR_SESSION =
5000
-
GET_FINANCIAL_CONNECTIONS_ACCOUNTS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_FINANCIAL_CONNECTIONS_SESSIONS_SESSION_MAX_LENGTH_FOR_SESSION =
5000
-
GET_FINANCIAL_CONNECTIONS_TRANSACTIONS_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_FINANCIAL_CONNECTIONS_TRANSACTIONS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_FINANCIAL_CONNECTIONS_TRANSACTIONS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_FINANCIAL_CONNECTIONS_TRANSACTIONS_TRANSACTION_MAX_LENGTH_FOR_TRANSACTION =
5000
-
POST_FINANCIAL_CONNECTIONS_ACCOUNTS_ACCOUNT_DISCONNECT_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_FINANCIAL_CONNECTIONS_ACCOUNTS_ACCOUNT_REFRESH_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_FINANCIAL_CONNECTIONS_ACCOUNTS_ACCOUNT_REFRESH_VALID_VALUES_FOR_FEATURES =
String.static_array("balance", "ownership", "transactions")
-
POST_FINANCIAL_CONNECTIONS_ACCOUNTS_ACCOUNT_SUBSCRIBE_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_FINANCIAL_CONNECTIONS_ACCOUNTS_ACCOUNT_SUBSCRIBE_VALID_VALUES_FOR_FEATURES =
String.static_array("transactions")
-
POST_FINANCIAL_CONNECTIONS_ACCOUNTS_ACCOUNT_UNSUBSCRIBE_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_FINANCIAL_CONNECTIONS_ACCOUNTS_ACCOUNT_UNSUBSCRIBE_VALID_VALUES_FOR_FEATURES =
String.static_array("transactions")
-
POST_FINANCIAL_CONNECTIONS_SESSIONS_MAX_LENGTH_FOR_RETURN_URL =
5000
-
POST_FINANCIAL_CONNECTIONS_SESSIONS_VALID_VALUES_FOR_PERMISSIONS =
String.static_array("balances", "ownership", "payment_method", "transactions")
-
POST_FINANCIAL_CONNECTIONS_SESSIONS_VALID_VALUES_FOR_PREFETCH =
String.static_array("balances", "ownership", "transactions")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_financial_connections_accounts(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, account_holder : Stripe::AccountholderParams | Nil = nil, session : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_financial_connections_accounts_account(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_financial_connections_sessions_session(*, session : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_financial_connections_transactions(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, transacted_at : Stripe::GetAccountsCreatedParameter | Nil = nil, transaction_refresh : Stripe::TransactionRefreshParams | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_financial_connections_transactions_transaction(*, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_financial_connections_accounts_account_disconnect(*, account : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_financial_connections_accounts_account_refresh(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_financial_connections_accounts_account_subscribe(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_financial_connections_accounts_account_unsubscribe(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_financial_connections_sessions(*, account_holder : Stripe::AccountholderParams | Nil = nil, permissions : Array(String) | Nil = nil, expand : Array(String) | Nil = nil, filters : Stripe::FiltersParams | Nil = nil, prefetch : Array(String) | Nil = nil, return_url : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_financial_connections_accounts(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, account_holder : Stripe::AccountholderParams | Nil = nil, session : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BankConnectionsResourceLinkedAccountList
Returns a list of Financial Connections
@optional @param ending_before [String?] A cursor for use in pagination.Account
objects. -
#get_financial_connections_accounts(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, account_holder : Stripe::AccountholderParams | Nil = nil, session : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of Financial Connections <code>Account</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_financial_connections_accounts_account(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FinancialConnectionsAccount
Retrieves the details of an Financial Connections
@required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.Account
. -
#get_financial_connections_accounts_account(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : 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.
-
#get_financial_connections_accounts_account_with_http_info(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FinancialConnectionsAccount, Int32, Hash(String, Array(String) | String))
<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.
-
#get_financial_connections_accounts_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, account_holder : Stripe::AccountholderParams | Nil = nil, session : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BankConnectionsResourceLinkedAccountList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of Financial Connections <code>Account</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_financial_connections_sessions_session(*, session : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FinancialConnectionsSession
Retrieves the details of a Financial Connections
@required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.Session
-
#get_financial_connections_sessions_session(*, session : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : 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.
-
#get_financial_connections_sessions_session_with_http_info(*, session : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FinancialConnectionsSession, Int32, Hash(String, Array(String) | String))
<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.
-
#get_financial_connections_transactions(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, transacted_at : Stripe::GetAccountsCreatedParameter | Nil = nil, transaction_refresh : Stripe::TransactionRefreshParams | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BankConnectionsResourceTransactionList
Returns a list of Financial Connections
@required @param account [String?] The ID of the Stripe account whose transactions will be retrieved.Transaction
objects. -
#get_financial_connections_transactions(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, transacted_at : Stripe::GetAccountsCreatedParameter | Nil = nil, transaction_refresh : Stripe::TransactionRefreshParams | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<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.
-
#get_financial_connections_transactions_transaction(*, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FinancialConnectionsTransaction
Retrieves the details of a Financial Connections
@required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.Transaction
-
#get_financial_connections_transactions_transaction(*, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : 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.
-
#get_financial_connections_transactions_transaction_with_http_info(*, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FinancialConnectionsTransaction, Int32, Hash(String, Array(String) | String))
<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.
-
#get_financial_connections_transactions_with_http_info(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, transacted_at : Stripe::GetAccountsCreatedParameter | Nil = nil, transaction_refresh : Stripe::TransactionRefreshParams | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BankConnectionsResourceTransactionList, Int32, Hash(String, Array(String) | String))
<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.
-
#post_financial_connections_accounts_account_disconnect(*, account : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::FinancialConnectionsAccount
Disables your access to a Financial Connections
Account
. -
#post_financial_connections_accounts_account_disconnect(*, account : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Disables your access to a Financial Connections <code>Account</code>.
-
#post_financial_connections_accounts_account_disconnect_with_http_info(*, account : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::FinancialConnectionsAccount, Int32, Hash(String, Array(String) | String))
<p>Disables your access to a Financial Connections <code>Account</code>.
-
#post_financial_connections_accounts_account_refresh(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::FinancialConnectionsAccount
Refreshes the data associated with a Financial Connections
@required @param account [String?] @required @param features [Array(String)?] The list of account features that you would like to refresh.Account
. -
#post_financial_connections_accounts_account_refresh(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : 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.
-
#post_financial_connections_accounts_account_refresh_with_http_info(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::FinancialConnectionsAccount, Int32, Hash(String, Array(String) | String))
<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.
-
#post_financial_connections_accounts_account_subscribe(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::FinancialConnectionsAccount
Subscribes to periodic refreshes of data associated with a Financial Connections
@required @param account [String?] @required @param features [Array(String)?] The list of account features to which you would like to subscribe.Account
. -
#post_financial_connections_accounts_account_subscribe(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : 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.
-
#post_financial_connections_accounts_account_subscribe_with_http_info(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::FinancialConnectionsAccount, Int32, Hash(String, Array(String) | String))
<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.
-
#post_financial_connections_accounts_account_unsubscribe(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::FinancialConnectionsAccount
Unsubscribes from periodic refreshes of data associated with a Financial Connections
@required @param account [String?] @required @param features [Array(String)?] The list of account features from which you would like to unsubscribe.Account
. -
#post_financial_connections_accounts_account_unsubscribe(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : 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.
-
#post_financial_connections_accounts_account_unsubscribe_with_http_info(*, account : String | Nil = nil, features : Array(String) | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::FinancialConnectionsAccount, Int32, Hash(String, Array(String) | String))
<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.
-
#post_financial_connections_sessions(*, account_holder : Stripe::AccountholderParams | Nil = nil, permissions : Array(String) | Nil = nil, expand : Array(String) | Nil = nil, filters : Stripe::FiltersParams | Nil = nil, prefetch : Array(String) | Nil = nil, return_url : String | Nil = nil) : Stripe::FinancialConnectionsSession
To launch the Financial Connections authorization flow, create a
Session
. -
#post_financial_connections_sessions(*, account_holder : Stripe::AccountholderParams | Nil = nil, permissions : Array(String) | Nil = nil, expand : Array(String) | Nil = nil, filters : Stripe::FiltersParams | Nil = nil, prefetch : Array(String) | Nil = nil, return_url : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>To launch the Financial Connections authorization flow, create a <code>Session</code>.
-
#post_financial_connections_sessions_with_http_info(*, account_holder : Stripe::AccountholderParams | Nil = nil, permissions : Array(String) | Nil = nil, expand : Array(String) | Nil = nil, filters : Stripe::FiltersParams | Nil = nil, prefetch : Array(String) | Nil = nil, return_url : String | Nil = nil) : Tuple(Stripe::FinancialConnectionsSession, Int32, Hash(String, Array(String) | String))
<p>To launch the Financial Connections authorization flow, create a <code>Session</code>.
Constructor Detail
Instance Method Detail
@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