View Source ExOAPI.Stripe.SDK.Accounts (exoapi_stripe v0.1.1)
Link to this section Summary
Functions
description: <p>With <a href="/docs/connect">Connect</a>, you can delete accounts you manage.</p>
description: <p>Delete a specified external account for a given account.</p>
description: <p>Delete a specified external account for a given account.</p>
description: <p>Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p>
description: <p>Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p>
description: <p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.</p>
description: <p>Retrieves the details of an account.</p>
description: <p>Retrieve a specified external account for a given account.</p>
description: <p>Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.</p>
description: <p>Retrieves information about the specified Account Capability.</p>
description: <p>List external accounts for an account.</p>
description: <p>Retrieve a specified external account for a given account.</p>
description: <p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>
description: <p>Retrieves an existing person.</p>
description: <p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>
description: <p>Retrieves an existing person.</p>
description: <p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users. To do this, you’ll first need to <a href="https://dashboard.stripe.com/account/applications/settings">register your platform</a>.</p>
description: <p>Updates a <a href="/docs/connect/accounts">connected account</a> by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked <strong>Custom Only</strong> below.) Parameters marked <strong>Custom and Express</strong> are not supported for Standard accounts.</p>
description: <p>Create an external account for a given account.</p>
description: <p>Updates the metadata, account holder name, account holder type of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p>
description: <p>Updates an existing Account Capability.</p>
description: <p>Create an external account for a given account.</p>
description: <p>Updates the metadata, account holder name, account holder type of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p>
description: <p>Creates a single-use login link for an Express account to access their Stripe dashboard.</p>
description: <p>Creates a new person.</p>
description: <p>Updates an existing person.</p>
description: <p>Creates a new person.</p>
description: <p>Updates an existing person.</p>
description: <p>With <a href="/docs/connect">Connect</a>, you may flag accounts as suspicious.</p>
Link to this section Types
@type get_accounts_account_bank_accounts_id_opts() :: {:expand, String.t()}
@type get_accounts_account_capabilities_capability_opts() :: {:expand, String.t()}
@type get_accounts_account_capabilities_opts() :: {:expand, String.t()}
@type get_accounts_account_external_accounts_id_opts() :: {:expand, String.t()}
@type get_accounts_account_opts() :: {:expand, String.t()}
@type get_accounts_account_people_person_opts() :: {:expand, String.t()}
@type get_accounts_account_persons_person_opts() :: {:expand, String.t()}
Link to this section Functions
@spec delete_accounts_account( client :: ExOAPI.Client.t(), body :: map(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>With <a href="/docs/connect">Connect</a>, you can delete accounts you manage.</p>
Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
If you want to delete your own account, use the account information tab in your account settings instead.
delete_accounts_account_bank_accounts_id(client, body, id, account)
View Source@spec delete_accounts_account_bank_accounts_id( client :: ExOAPI.Client.t(), body :: map(), id :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Delete a specified external account for a given account.</p>
delete_accounts_account_external_accounts_id(client, body, id, account)
View Source@spec delete_accounts_account_external_accounts_id( client :: ExOAPI.Client.t(), body :: map(), id :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Delete a specified external account for a given account.</p>
delete_accounts_account_people_person(client, body, person, account)
View Source@spec delete_accounts_account_people_person( client :: ExOAPI.Client.t(), body :: map(), person :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p>
delete_accounts_account_persons_person(client, body, person, account)
View Source@spec delete_accounts_account_persons_person( client :: ExOAPI.Client.t(), body :: map(), person :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p>
@spec get_accounts(client :: ExOAPI.Client.t(), [get_accounts_opts()]) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.</p>
@spec get_accounts_account( client :: ExOAPI.Client.t(), account :: String.t(), [get_accounts_account_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves the details of an account.</p>
get_accounts_account_bank_accounts_id(client, id, account, opts \\ [])
View Source@spec get_accounts_account_bank_accounts_id( client :: ExOAPI.Client.t(), id :: String.t(), account :: String.t(), [get_accounts_account_bank_accounts_id_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieve a specified external account for a given account.</p>
@spec get_accounts_account_capabilities( client :: ExOAPI.Client.t(), account :: String.t(), [get_accounts_account_capabilities_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.</p>
get_accounts_account_capabilities_capability(client, capability, account, opts \\ [])
View Source@spec get_accounts_account_capabilities_capability( client :: ExOAPI.Client.t(), capability :: String.t(), account :: String.t(), [get_accounts_account_capabilities_capability_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves information about the specified Account Capability.</p>
get_accounts_account_external_accounts(client, account, opts \\ [])
View Source@spec get_accounts_account_external_accounts( client :: ExOAPI.Client.t(), account :: String.t(), [get_accounts_account_external_accounts_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>List external accounts for an account.</p>
get_accounts_account_external_accounts_id(client, id, account, opts \\ [])
View Source@spec get_accounts_account_external_accounts_id( client :: ExOAPI.Client.t(), id :: String.t(), account :: String.t(), [get_accounts_account_external_accounts_id_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieve a specified external account for a given account.</p>
@spec get_accounts_account_people( client :: ExOAPI.Client.t(), account :: String.t(), [get_accounts_account_people_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>
get_accounts_account_people_person(client, person, account, opts \\ [])
View Source@spec get_accounts_account_people_person( client :: ExOAPI.Client.t(), person :: String.t(), account :: String.t(), [get_accounts_account_people_person_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves an existing person.</p>
@spec get_accounts_account_persons( client :: ExOAPI.Client.t(), account :: String.t(), [get_accounts_account_persons_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>
get_accounts_account_persons_person(client, person, account, opts \\ [])
View Source@spec get_accounts_account_persons_person( client :: ExOAPI.Client.t(), person :: String.t(), account :: String.t(), [get_accounts_account_persons_person_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves an existing person.</p>
@spec post_accounts(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users. To do this, you’ll first need to <a href="https://dashboard.stripe.com/account/applications/settings">register your platform</a>.</p>
@spec post_accounts_account( client :: ExOAPI.Client.t(), body :: map(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates a <a href="/docs/connect/accounts">connected account</a> by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked <strong>Custom Only</strong> below.) Parameters marked <strong>Custom and Express</strong> are not supported for Standard accounts.</p>
To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
@spec post_accounts_account_bank_accounts( client :: ExOAPI.Client.t(), body :: map(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Create an external account for a given account.</p>
@spec post_accounts_account_bank_accounts_id( client :: ExOAPI.Client.t(), body :: map(), id :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates the metadata, account holder name, account holder type of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p>
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
post_accounts_account_capabilities_capability(client, body, capability, account)
View Source@spec post_accounts_account_capabilities_capability( client :: ExOAPI.Client.t(), body :: map(), capability :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates an existing Account Capability.</p>
@spec post_accounts_account_external_accounts( client :: ExOAPI.Client.t(), body :: map(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Create an external account for a given account.</p>
post_accounts_account_external_accounts_id(client, body, id, account)
View Source@spec post_accounts_account_external_accounts_id( client :: ExOAPI.Client.t(), body :: map(), id :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates the metadata, account holder name, account holder type of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p>
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
@spec post_accounts_account_login_links( client :: ExOAPI.Client.t(), body :: map(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Creates a single-use login link for an Express account to access their Stripe dashboard.</p>
You may only create login links for Express accounts connected to your platform.
@spec post_accounts_account_people( client :: ExOAPI.Client.t(), body :: map(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Creates a new person.</p>
post_accounts_account_people_person(client, body, person, account)
View Source@spec post_accounts_account_people_person( client :: ExOAPI.Client.t(), body :: map(), person :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates an existing person.</p>
@spec post_accounts_account_persons( client :: ExOAPI.Client.t(), body :: map(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Creates a new person.</p>
post_accounts_account_persons_person(client, body, person, account)
View Source@spec post_accounts_account_persons_person( client :: ExOAPI.Client.t(), body :: map(), person :: String.t(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates an existing person.</p>
@spec post_accounts_account_reject( client :: ExOAPI.Client.t(), body :: map(), account :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>With <a href="/docs/connect">Connect</a>, you may flag accounts as suspicious.</p>
Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.