Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostAccountsAccountExternalAccountsId

Description

Contains the different functions to run the operation postAccountsAccountExternalAccountsId

Synopsis

postAccountsAccountExternalAccountsId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Text -> Maybe PostAccountsAccountExternalAccountsIdRequestBody -> m (Either HttpException (Response PostAccountsAccountExternalAccountsIdResponse))
postAccountsAccountExternalAccountsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Text -> Maybe PostAccountsAccountExternalAccountsIdRequestBody -> m (Either HttpException (Response ByteString))
postAccountsAccountExternalAccountsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostAccountsAccountExternalAccountsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountsAccountExternalAccountsIdResponse))
postAccountsAccountExternalAccountsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostAccountsAccountExternalAccountsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostAccountsAccountExternalAccountsIdRequestBody = PostAccountsAccountExternalAccountsIdRequestBody {
}
data PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'
data PostAccountsAccountExternalAccountsIdRequestBodyMetadata' = PostAccountsAccountExternalAccountsIdRequestBodyMetadata' {
}
data PostAccountsAccountExternalAccountsIdResponse

Documentation

postAccountsAccountExternalAccountsId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	account \| Constraints: Maximum length of 5000
-> Text	id
-> Maybe PostAccountsAccountExternalAccountsIdRequestBody	The request body to send
-> m (Either HttpException (Response PostAccountsAccountExternalAccountsIdResponse))	Monad containing the result of the operation

POST /v1/accounts/{account}/external_accounts/{id}

<p>Updates the metadata, account holder name, and 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> <p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>

postAccountsAccountExternalAccountsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Text -> Maybe PostAccountsAccountExternalAccountsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/accounts/{account}/external_accounts/{id}

The same as postAccountsAccountExternalAccountsId but returns the raw ByteString

postAccountsAccountExternalAccountsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostAccountsAccountExternalAccountsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountsAccountExternalAccountsIdResponse)) Source #

POST /v1/accounts/{account}/external_accounts/{id}

Monadic version of postAccountsAccountExternalAccountsId (use with runWithConfiguration)

postAccountsAccountExternalAccountsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Text -> Maybe PostAccountsAccountExternalAccountsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/accounts/{account}/external_accounts/{id}

Monadic version of postAccountsAccountExternalAccountsIdRaw (use with runWithConfiguration)

data PostAccountsAccountExternalAccountsIdRequestBody Source #

Defines the data type for the schema postAccountsAccountExternalAccountsIdRequestBody

Constructors

PostAccountsAccountExternalAccountsIdRequestBody

Fields

postAccountsAccountExternalAccountsIdRequestBodyAccountHolderName :: Maybe Text
account_holder_name: The name of the person or business that owns the bank account.
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyAccountHolderType :: Maybe PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'
account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyAddressCity :: Maybe Text
address_city: City/District/Suburb/Town/Village.
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyAddressCountry :: Maybe Text
address_country: Billing address country, if provided when creating card.
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyAddressLine1 :: Maybe Text
address_line1: Address line 1 (Street address/PO Box/Company name).
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyAddressLine2 :: Maybe Text
address_line2: Address line 2 (Apartment/Suite/Unit/Building).
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyAddressState :: Maybe Text
address_state: State/County/Province/Region.
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyAddressZip :: Maybe Text
address_zip: ZIP or postal code.
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyDefaultForCurrency :: Maybe Bool
default_for_currency: When set to true, this becomes the default external account for its currency.
postAccountsAccountExternalAccountsIdRequestBodyExpMonth :: Maybe Text
exp_month: Two digit number representing the card’s expiration month.
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyExpYear :: Maybe Text
exp_year: Four digit number representing the card’s expiration year.
Constraints:
- Maximum length of 5000
postAccountsAccountExternalAccountsIdRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postAccountsAccountExternalAccountsIdRequestBodyMetadata :: Maybe PostAccountsAccountExternalAccountsIdRequestBodyMetadata'
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
postAccountsAccountExternalAccountsIdRequestBodyName :: Maybe Text
name: Cardholder name.
Constraints:
- Maximum length of 5000

Instances

Eq PostAccountsAccountExternalAccountsIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods (==) :: PostAccountsAccountExternalAccountsIdRequestBody -> PostAccountsAccountExternalAccountsIdRequestBody -> Bool # (/=) :: PostAccountsAccountExternalAccountsIdRequestBody -> PostAccountsAccountExternalAccountsIdRequestBody -> Bool #
Show PostAccountsAccountExternalAccountsIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods showsPrec :: Int -> PostAccountsAccountExternalAccountsIdRequestBody -> ShowS # show :: PostAccountsAccountExternalAccountsIdRequestBody -> String # showList :: [PostAccountsAccountExternalAccountsIdRequestBody] -> ShowS #
ToJSON PostAccountsAccountExternalAccountsIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods toJSON :: PostAccountsAccountExternalAccountsIdRequestBody -> Value # toEncoding :: PostAccountsAccountExternalAccountsIdRequestBody -> Encoding # toJSONList :: [PostAccountsAccountExternalAccountsIdRequestBody] -> Value # toEncodingList :: [PostAccountsAccountExternalAccountsIdRequestBody] -> Encoding #
FromJSON PostAccountsAccountExternalAccountsIdRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods parseJSON :: Value -> Parser PostAccountsAccountExternalAccountsIdRequestBody # parseJSONList :: Value -> Parser [PostAccountsAccountExternalAccountsIdRequestBody] #

data PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' Source #

Defines the enum schema postAccountsAccountExternalAccountsIdRequestBodyAccount_holder_type'

The type of entity that holds the account. This can be either `individual` or `company`.

Constructors

PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'EnumOther Value
PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'EnumTyped Text
PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'EnumString_
PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'EnumStringCompany
PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'EnumStringIndividual

Instances

Eq PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods (==) :: PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' -> PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' -> Bool # (/=) :: PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' -> PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' -> Bool #
Show PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods showsPrec :: Int -> PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' -> ShowS # show :: PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' -> String # showList :: [PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'] -> ShowS #
ToJSON PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods toJSON :: PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' -> Value # toEncoding :: PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' -> Encoding # toJSONList :: [PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'] -> Value # toEncodingList :: [PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'] -> Encoding #
FromJSON PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods parseJSON :: Value -> Parser PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType' # parseJSONList :: Value -> Parser [PostAccountsAccountExternalAccountsIdRequestBodyAccountHolderType'] #

data PostAccountsAccountExternalAccountsIdRequestBodyMetadata' Source #

Defines the data type for the schema postAccountsAccountExternalAccountsIdRequestBodyMetadata'

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostAccountsAccountExternalAccountsIdRequestBodyMetadata'

Instances

Eq PostAccountsAccountExternalAccountsIdRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods (==) :: PostAccountsAccountExternalAccountsIdRequestBodyMetadata' -> PostAccountsAccountExternalAccountsIdRequestBodyMetadata' -> Bool # (/=) :: PostAccountsAccountExternalAccountsIdRequestBodyMetadata' -> PostAccountsAccountExternalAccountsIdRequestBodyMetadata' -> Bool #
Show PostAccountsAccountExternalAccountsIdRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods showsPrec :: Int -> PostAccountsAccountExternalAccountsIdRequestBodyMetadata' -> ShowS # show :: PostAccountsAccountExternalAccountsIdRequestBodyMetadata' -> String # showList :: [PostAccountsAccountExternalAccountsIdRequestBodyMetadata'] -> ShowS #
ToJSON PostAccountsAccountExternalAccountsIdRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods toJSON :: PostAccountsAccountExternalAccountsIdRequestBodyMetadata' -> Value # toEncoding :: PostAccountsAccountExternalAccountsIdRequestBodyMetadata' -> Encoding # toJSONList :: [PostAccountsAccountExternalAccountsIdRequestBodyMetadata'] -> Value # toEncodingList :: [PostAccountsAccountExternalAccountsIdRequestBodyMetadata'] -> Encoding #
FromJSON PostAccountsAccountExternalAccountsIdRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods parseJSON :: Value -> Parser PostAccountsAccountExternalAccountsIdRequestBodyMetadata' # parseJSONList :: Value -> Parser [PostAccountsAccountExternalAccountsIdRequestBodyMetadata'] #

data PostAccountsAccountExternalAccountsIdResponse Source #

Represents a response of the operation postAccountsAccountExternalAccountsId.

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), PostAccountsAccountExternalAccountsIdResponseError is used.

Constructors

PostAccountsAccountExternalAccountsIdResponseError String	Means either no matching case available or a parse error
PostAccountsAccountExternalAccountsIdResponse200 ExternalAccount	Successful response.
PostAccountsAccountExternalAccountsIdResponseDefault Error	Error response.

Instances

Eq PostAccountsAccountExternalAccountsIdResponse Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods (==) :: PostAccountsAccountExternalAccountsIdResponse -> PostAccountsAccountExternalAccountsIdResponse -> Bool # (/=) :: PostAccountsAccountExternalAccountsIdResponse -> PostAccountsAccountExternalAccountsIdResponse -> Bool #
Show PostAccountsAccountExternalAccountsIdResponse Source #
Instance details Defined in StripeAPI.Operations.PostAccountsAccountExternalAccountsId Methods showsPrec :: Int -> PostAccountsAccountExternalAccountsIdResponse -> ShowS # show :: PostAccountsAccountExternalAccountsIdResponse -> String # showList :: [PostAccountsAccountExternalAccountsIdResponse] -> ShowS #