Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetAccountExternalAccounts

Contains the different functions to run the operation getAccountExternalAccounts

9 types
4 values

Packagestripeapi-3.0.0.0
Exports13
LanguageHaskell2010
LicenceMIT
SourceGetAccountExternalAccounts.hs

valuegetAccountExternalAccounts

:: MonadHTTP m
=> GetAccountExternalAccountsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetAccountExternalAccountsResponse)
Monadic computation which returns the result of the operation

GET /v1/account/external_accounts

<p>List external accounts for an account.</p>

datadata GetAccountExternalAccountsParameters

Defines the object schema located at paths./v1/account/external_accounts.GET.parameters in the specification.

Constructors

GetAccountExternalAccountsParameters
- getAccountExternalAccountsParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named 'ending_before'
  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.
- getAccountExternalAccountsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getAccountExternalAccountsParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getAccountExternalAccountsParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named 'starting_after'
  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.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountExternalAccountsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
FromJSON GetAccountExternalAccountsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
ToJSON GetAccountExternalAccountsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts

valuemkGetAccountExternalAccountsParameters :: GetAccountExternalAccountsParameters

Create a new GetAccountExternalAccountsParameters with all required fields.

datadata GetAccountExternalAccountsResponse

Represents a response of the operation getAccountExternalAccounts.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetAccountExternalAccountsResponseError is used.

Constructors

GetAccountExternalAccountsResponseError String
Means either no matching case available or a parse error
GetAccountExternalAccountsResponse200 GetAccountExternalAccountsResponseBody200
Successful response.
GetAccountExternalAccountsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetAccountExternalAccountsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts

datadata GetAccountExternalAccountsResponseBody200

Defines the object schema located at paths./v1/account/external_accounts.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetAccountExternalAccountsResponseBody200
- getAccountExternalAccountsResponseBody200Data :: [GetAccountExternalAccountsResponseBody200Data']
  data: The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
- getAccountExternalAccountsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getAccountExternalAccountsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountExternalAccountsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
FromJSON GetAccountExternalAccountsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
ToJSON GetAccountExternalAccountsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts

valuemkGetAccountExternalAccountsResponseBody200

:: [GetAccountExternalAccountsResponseBody200Data']
getAccountExternalAccountsResponseBody200Data
-> Bool
getAccountExternalAccountsResponseBody200HasMore
-> Text
getAccountExternalAccountsResponseBody200Url
-> GetAccountExternalAccountsResponseBody200

Create a new GetAccountExternalAccountsResponseBody200 with all required fields.

datadata GetAccountExternalAccountsResponseBody200Data'

Defines the object schema located at paths./v1/account/external_accounts.GET.responses.200.content.application/json.schema.properties.data.items.anyOf in the specification.

Constructors

GetAccountExternalAccountsResponseBody200Data'
- getAccountExternalAccountsResponseBody200Data'Account :: Maybe (Nullable GetAccountExternalAccountsResponseBody200Data'Account'NonNullableVariants)
  account: The ID of the account that the bank account is associated with.
- getAccountExternalAccountsResponseBody200Data'AccountHolderName :: Maybe (Nullable Text)
  account_holder_name: The name of the person or business that owns the bank account.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AccountHolderType :: Maybe (Nullable Text)
  account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AccountType :: Maybe (Nullable Text)
  account_type: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AddressCity :: Maybe (Nullable Text)
  address_city: City/District/Suburb/Town/Village.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AddressCountry :: Maybe (Nullable Text)
  address_country: Billing address country, if provided when creating card.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AddressLine1 :: Maybe (Nullable Text)
  address_line1: Address line 1 (Street address/PO Box/Company name).
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AddressLine1Check :: Maybe (Nullable Text)
  address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AddressLine2 :: Maybe (Nullable Text)
  address_line2: Address line 2 (Apartment/Suite/Unit/Building).
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AddressState :: Maybe (Nullable Text)
  address_state: State/County/Province/Region.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AddressZip :: Maybe (Nullable Text)
  address_zip: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AddressZipCheck :: Maybe (Nullable Text)
  address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods :: Maybe (Nullable [GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullable])
  available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.
- getAccountExternalAccountsResponseBody200Data'BankName :: Maybe (Nullable Text)
  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Brand :: Maybe Text
  brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Country :: Maybe Text
  country: Two-letter ISO code representing the country the bank account is located in.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Currency :: Maybe Text
  currency: Three-letter ISO code for the currency paid out to the bank account.
- getAccountExternalAccountsResponseBody200Data'Customer :: Maybe (Nullable GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableVariants)
  customer: The ID of the customer that the bank account is associated with.
- getAccountExternalAccountsResponseBody200Data'CvcCheck :: Maybe (Nullable Text)
  cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'DefaultForCurrency :: Maybe (Nullable Bool)
  default_for_currency: Whether this bank account is the default external account for its currency.
- getAccountExternalAccountsResponseBody200Data'DynamicLast4 :: Maybe (Nullable Text)
  dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'ExpMonth :: Maybe Int
  exp_month: Two-digit number representing the card's expiration month.
- getAccountExternalAccountsResponseBody200Data'ExpYear :: Maybe Int
  exp_year: Four-digit number representing the card's expiration year.
- getAccountExternalAccountsResponseBody200Data'Fingerprint :: Maybe (Nullable Text)
  fingerprint: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Funding :: Maybe Text
  funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Id :: Maybe Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Last4 :: Maybe Text
  last4: The last four digits of the bank account number.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Metadata :: Maybe (Nullable Object)
  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- getAccountExternalAccountsResponseBody200Data'Name :: Maybe (Nullable Text)
  name: Cardholder name.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Object :: Maybe GetAccountExternalAccountsResponseBody200Data'Object'
  object: String representing the object's type. Objects of the same type share the same value.
- getAccountExternalAccountsResponseBody200Data'Recipient :: Maybe (Nullable GetAccountExternalAccountsResponseBody200Data'Recipient'NonNullableVariants)
  recipient: The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
- getAccountExternalAccountsResponseBody200Data'RoutingNumber :: Maybe (Nullable Text)
  routing_number: The routing transit number for the bank account.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'Status :: Maybe Text
  status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.
  For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.
  Constraints:
  - Maximum length of 5000
- getAccountExternalAccountsResponseBody200Data'TokenizationMethod :: Maybe (Nullable Text)
  tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountExternalAccountsResponseBody200Data'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsResponseBody200Data'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
FromJSON GetAccountExternalAccountsResponseBody200Data'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
ToJSON GetAccountExternalAccountsResponseBody200Data'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts

valuemkGetAccountExternalAccountsResponseBody200Data' :: GetAccountExternalAccountsResponseBody200Data'

Create a new GetAccountExternalAccountsResponseBody200Data' with all required fields.

datadata GetAccountExternalAccountsResponseBody200Data'Account'NonNullableVariants

Defines the oneOf schema located at paths./v1/account/external_accounts.GET.responses.200.content.application/json.schema.properties.data.items.anyOf.properties.account.anyOf in the specification.

The ID of the account that the bank account is associated with.

Constructors

GetAccountExternalAccountsResponseBody200Data'Account'NonNullableText Text
GetAccountExternalAccountsResponseBody200Data'Account'NonNullableAccount Account

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountExternalAccountsResponseBody200Data'Account'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsResponseBody200Data'Account'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
FromJSON GetAccountExternalAccountsResponseBody200Data'Account'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
ToJSON GetAccountExternalAccountsResponseBody200Data'Account'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts

datadata GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullable

Defines the enum schema located at paths./v1/account/external_accounts.GET.responses.200.content.application/json.schema.properties.data.items.anyOf.properties.available_payout_methods.items in the specification.

Constructors

GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullableEnumInstant
Represents the JSON value "instant"
GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullableEnumStandard
Represents the JSON value "standard"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
FromJSON GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
ToJSON GetAccountExternalAccountsResponseBody200Data'AvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts

datadata GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableVariants

Defines the oneOf schema located at paths./v1/account/external_accounts.GET.responses.200.content.application/json.schema.properties.data.items.anyOf.properties.customer.anyOf in the specification.

The ID of the customer that the bank account is associated with.

Constructors

GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableText Text
GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableCustomer Customer
GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableDeletedCustomer DeletedCustomer

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
FromJSON GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
ToJSON GetAccountExternalAccountsResponseBody200Data'Customer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts

datadata GetAccountExternalAccountsResponseBody200Data'Object'

Defines the enum schema located at paths./v1/account/external_accounts.GET.responses.200.content.application/json.schema.properties.data.items.anyOf.properties.object in the specification.

String representing the object's type. Objects of the same type share the same value.

Constructors

GetAccountExternalAccountsResponseBody200Data'Object'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetAccountExternalAccountsResponseBody200Data'Object'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetAccountExternalAccountsResponseBody200Data'Object'EnumBankAccount
Represents the JSON value "bank_account"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountExternalAccountsResponseBody200Data'Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsResponseBody200Data'Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
FromJSON GetAccountExternalAccountsResponseBody200Data'Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
ToJSON GetAccountExternalAccountsResponseBody200Data'Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts

datadata GetAccountExternalAccountsResponseBody200Data'Recipient'NonNullableVariants

Defines the oneOf schema located at paths./v1/account/external_accounts.GET.responses.200.content.application/json.schema.properties.data.items.anyOf.properties.recipient.anyOf in the specification.

The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

Constructors

GetAccountExternalAccountsResponseBody200Data'Recipient'NonNullableText Text
GetAccountExternalAccountsResponseBody200Data'Recipient'NonNullableRecipient Recipient

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAccountExternalAccountsResponseBody200Data'Recipient'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
Show GetAccountExternalAccountsResponseBody200Data'Recipient'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
FromJSON GetAccountExternalAccountsResponseBody200Data'Recipient'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts
ToJSON GetAccountExternalAccountsResponseBody200Data'Recipient'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAccountExternalAccounts