Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostAccountExternalAccountsId

Description

Contains the different functions to run the operation postAccountExternalAccountsId

Synopsis

postAccountExternalAccountsId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostAccountExternalAccountsIdRequestBody -> m (Either HttpException (Response PostAccountExternalAccountsIdResponse))
postAccountExternalAccountsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostAccountExternalAccountsIdRequestBody -> m (Either HttpException (Response ByteString))
postAccountExternalAccountsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostAccountExternalAccountsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountExternalAccountsIdResponse))
postAccountExternalAccountsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostAccountExternalAccountsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostAccountExternalAccountsIdRequestBody = PostAccountExternalAccountsIdRequestBody {
}
data PostAccountExternalAccountsIdRequestBodyAccountHolderType'
data PostAccountExternalAccountsIdRequestBodyMetadata' = PostAccountExternalAccountsIdRequestBodyMetadata' {
}
data PostAccountExternalAccountsIdResponse

Documentation

postAccountExternalAccountsId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> String	id
-> PostAccountExternalAccountsIdRequestBody	The request body to send
-> m (Either HttpException (Response PostAccountExternalAccountsIdResponse))	Monad containing the result of the operation

POST /v1/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>

postAccountExternalAccountsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostAccountExternalAccountsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/account/external_accounts/{id}

The same as postAccountExternalAccountsId but returns the raw ByteString

postAccountExternalAccountsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostAccountExternalAccountsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountExternalAccountsIdResponse)) Source #

POST /v1/account/external_accounts/{id}

Monadic version of postAccountExternalAccountsId (use with runWithConfiguration)

postAccountExternalAccountsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostAccountExternalAccountsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/account/external_accounts/{id}

Monadic version of postAccountExternalAccountsIdRaw (use with runWithConfiguration)

data PostAccountExternalAccountsIdRequestBody Source #

Defines the data type for the schema postAccountExternalAccountsIdRequestBody

Constructors

PostAccountExternalAccountsIdRequestBody

Fields

postAccountExternalAccountsIdRequestBodyAccountHolderName :: Maybe String
account_holder_name: The name of the person or business that owns the bank account.
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyAccountHolderType :: Maybe PostAccountExternalAccountsIdRequestBodyAccountHolderType'
account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyAddressCity :: Maybe String
address_city: City/District/Suburb/Town/Village.
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyAddressCountry :: Maybe String
address_country: Billing address country, if provided when creating card.
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyAddressLine1 :: Maybe String
address_line1: Address line 1 (Street address/PO Box/Company name).
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyAddressLine2 :: Maybe String
address_line2: Address line 2 (Apartment/Suite/Unit/Building).
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyAddressState :: Maybe String
address_state: State/County/Province/Region.
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyAddressZip :: Maybe String
address_zip: ZIP or postal code.
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyDefaultForCurrency :: Maybe Bool
default_for_currency: When set to true, this becomes the default external account for its currency.
postAccountExternalAccountsIdRequestBodyExpMonth :: Maybe String
exp_month: Two digit number representing the card’s expiration month.
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyExpYear :: Maybe String
exp_year: Four digit number representing the card’s expiration year.
Constraints:
- Maximum length of 5000
postAccountExternalAccountsIdRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postAccountExternalAccountsIdRequestBodyMetadata :: Maybe PostAccountExternalAccountsIdRequestBodyMetadata'
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`.
postAccountExternalAccountsIdRequestBodyName :: Maybe String
name: Cardholder name.
Constraints:
- Maximum length of 5000

Instances

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

data PostAccountExternalAccountsIdRequestBodyAccountHolderType' Source #

Defines the enum schema postAccountExternalAccountsIdRequestBodyAccount_holder_type'

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

Constructors

PostAccountExternalAccountsIdRequestBodyAccountHolderType'EnumOther Value
PostAccountExternalAccountsIdRequestBodyAccountHolderType'EnumTyped String
PostAccountExternalAccountsIdRequestBodyAccountHolderType'EnumString_
PostAccountExternalAccountsIdRequestBodyAccountHolderType'EnumStringCompany
PostAccountExternalAccountsIdRequestBodyAccountHolderType'EnumStringIndividual

Instances

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

data PostAccountExternalAccountsIdRequestBodyMetadata' Source #

Defines the data type for the schema postAccountExternalAccountsIdRequestBodyMetadata'

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

PostAccountExternalAccountsIdRequestBodyMetadata'

Instances

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

data PostAccountExternalAccountsIdResponse Source #

Represents a response of the operation postAccountExternalAccountsId.

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

Constructors

PostAccountExternalAccountsIdResponseError String	Means either no matching case available or a parse error
PostAccountExternalAccountsIdResponse200 ExternalAccount	Successful response.
PostAccountExternalAccountsIdResponseDefault Error	Error response.

Instances

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