public class

StripeAccountClient

extends Object
java.lang.Object
   ↳ com.wsl.modules.stripe.client.StripeAccountClient

Class Overview

Encapsulates Account-related Stripe API calls.

Summary

Public Constructors
StripeAccountClient()
Public Methods
Account createAccount(boolean managed, String country, String email, String businessName, String businessUrl, String supportPhone, BankAccount bankAccount, boolean debitNegativeBalances, String defaultCurrency, LegalEntity legalEntity, String productDescription, String statementDescriptor, Acceptance tosAcceptance, TransferSchedule transferSchedule, Map<String, Object> metadata)
Create an Account
Account retrieveAccount(String id)
Retrieve an Account's Details
Account updateAccount(String id, String email, String businessName, String businessUrl, String supportPhone, BankAccount bankAccount, boolean debitNegativeBalances, String defaultCurrency, LegalEntity legalEntity, String productDescription, String statementDescriptor, Acceptance tosAcceptance, TransferSchedule transferSchedule, Map<String, Object> metadata)
Update an Account You may only update accounts that you manage.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public StripeAccountClient ()

Public Methods

public Account createAccount (boolean managed, String country, String email, String businessName, String businessUrl, String supportPhone, BankAccount bankAccount, boolean debitNegativeBalances, String defaultCurrency, LegalEntity legalEntity, String productDescription, String statementDescriptor, Acceptance tosAcceptance, TransferSchedule transferSchedule, Map<String, Object> metadata)

Create an Account

Parameters
managed Whether you'd like to create a managed or standalone account. Managed accounts have extra parameters available to them, and require that you, the platform, handle all communication with the account holder. Standalone accounts are normal Stripe accounts: Stripe will email the account holder to setup a username and password, and handle all account management directly with them.
country The country the account holder resides in or that the business is legally established in. For example, if you are in the United States and the business you’re creating an account for is legally represented in Canada, you would use “CA” as the country for the account being created.
email The email address of the account holder. For standalone accounts, Stripe will email your user with instructions for how to set up their account. For managed accounts, this is only to make the account easier to identify to you: Stripe will never directly reach out to your users.
businessName The publicly sharable name for this account
businessUrl The URL that best shows the service or product provided for this account
supportPhone A publicly shareable phone number that can be reached for support for this account
bankAccount A bank account to attach to the account.
debitNegativeBalances A boolean for whether or not Stripe should try to reclaim negative balances from the account holder’s bank account.
defaultCurrency Three-letter ISO currency code representing the default currency for the account.
legalEntity Information about the holder of this account, i.e. the user receiving funds from this account
productDescription Internal-only description of the product being sold or service being provided by this account. It’s used by Stripe for risk and underwriting purposes.
statementDescriptor The text that will appear on credit card statements by default if a charge is being made directly on the account.
tosAcceptance Details on who accepted the Stripe terms of service, and when they accepted it.
transferSchedule Details on when this account will make funds from charges available, and when they will be paid out to the account holder’s bank account.
metadata A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about the account in a structured format. This will be unset if you POST an empty value.
Returns
  • Returns an account object if the call succeeded.
Throws
StripeConnectorException when there is a problem with the Connector

public Account retrieveAccount (String id)

Retrieve an Account's Details

Parameters
id The identifier of the account to be retrieved.
Returns
  • Returns Account
Throws
StripeConnectorException when there is a problem with the Connector

public Account updateAccount (String id, String email, String businessName, String businessUrl, String supportPhone, BankAccount bankAccount, boolean debitNegativeBalances, String defaultCurrency, LegalEntity legalEntity, String productDescription, String statementDescriptor, Acceptance tosAcceptance, TransferSchedule transferSchedule, Map<String, Object> metadata)

Update an Account You may only update accounts that you manage. To update your own account, you can currently only do so via the dashboard.

Parameters
id The account to update
email The email address of the account holder. For standalone accounts, Stripe will email your user with instructions for how to set up their account. For managed accounts, this is only to make the account easier to identify to you: Stripe will never directly reach out to your users.
businessName The publicly sharable name for this account
businessUrl The URL that best shows the service or product provided for this account
supportPhone A publicly shareable phone number that can be reached for support for this account
bankAccount The bank account to associate with the account
debitNegativeBalances A boolean for whether or not Stripe should try to reclaim negative balances from the account holder’s bank account.
defaultCurrency Three-letter ISO currency code representing the default currency for the account.
legalEntity Information about the holder of this account, i.e. the user receiving funds from this account
productDescription Internal-only description of the product being sold or service being provided by this account. It’s used by Stripe for risk and underwriting purposes.
statementDescriptor The text that will appear on credit card statements by default if a charge is being made directly on the account.
tosAcceptance Details on who accepted the Stripe terms of service, and when they accepted it.
transferSchedule Details on when this account will make funds from charges available, and when they will be paid out to the account holder’s bank account.
metadata A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about the account in a structured format. This will be unset if you POST an empty value.
Returns
  • Returns an account object if the call succeeded.
Throws
StripeConnectorException when there is a problem with the Connector