Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.Issuing_Authorization

Description

Contains the types generated from the schema Issuing_Authorization

Synopsis

data Issuing'authorization = Issuing'authorization {
}
mkIssuing'authorization :: Int -> Bool -> Issuing'authorizationAuthorizationMethod' -> [BalanceTransaction] -> Issuing'card -> Int -> Text -> Text -> Bool -> Int -> Text -> IssuingAuthorizationMerchantData -> Object -> [IssuingAuthorizationRequest] -> Issuing'authorizationStatus' -> [Issuing'transaction] -> IssuingAuthorizationVerificationData -> Issuing'authorization
data Issuing'authorizationAmountDetails' = Issuing'authorizationAmountDetails' {
- issuing'authorizationAmountDetails'AtmFee :: Maybe Int
}
mkIssuing'authorizationAmountDetails' :: Issuing'authorizationAmountDetails'
data Issuing'authorizationAuthorizationMethod'
data Issuing'authorizationCardholder'Variants
- = Issuing'authorizationCardholder'Text Text
- | Issuing'authorizationCardholder'Issuing'cardholder Issuing'cardholder
data Issuing'authorizationPendingRequest' = Issuing'authorizationPendingRequest' {
}
mkIssuing'authorizationPendingRequest' :: Issuing'authorizationPendingRequest'
data Issuing'authorizationPendingRequest'AmountDetails' = Issuing'authorizationPendingRequest'AmountDetails' {
- issuing'authorizationPendingRequest'AmountDetails'AtmFee :: Maybe Int
}
mkIssuing'authorizationPendingRequest'AmountDetails' :: Issuing'authorizationPendingRequest'AmountDetails'
data Issuing'authorizationStatus'

Documentation

data Issuing'authorization Source #

Defines the object schema located at components.schemas.issuing.authorization in the specification.

When an issued card is used to make a purchase, an Issuing `Authorization` object is created. Authorizations must be approved for the purchase to be completed successfully.

Related guide: Issued Card Authorizations.

Constructors

Issuing'authorization

Fields

issuing'authorizationAmount :: Int
amount: The total amount that was authorized or rejected. This amount is in the card's currency and in the smallest currency unit.
issuing'authorizationAmountDetails :: Maybe Issuing'authorizationAmountDetails'
amount_details: Detailed breakdown of amount components. These amounts are denominated in `currency` and in the smallest currency unit.
issuing'authorizationApproved :: Bool
approved: Whether the authorization has been approved.
issuing'authorizationAuthorizationMethod :: Issuing'authorizationAuthorizationMethod'
authorization_method: How the card details were provided.
issuing'authorizationBalanceTransactions :: [BalanceTransaction]
balance_transactions: List of balance transactions associated with this authorization.
issuing'authorizationCard :: Issuing'card
card: You can create physical or virtual cards that are issued to cardholders.
issuing'authorizationCardholder :: Maybe Issuing'authorizationCardholder'Variants
cardholder: The cardholder to whom this authorization belongs.
issuing'authorizationCreated :: Int
created: Time at which the object was created. Measured in seconds since the Unix epoch.
issuing'authorizationCurrency :: Text
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
issuing'authorizationId :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
issuing'authorizationLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
issuing'authorizationMerchantAmount :: Int
merchant_amount: The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the smallest currency unit.
issuing'authorizationMerchantCurrency :: Text
merchant_currency: The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.
issuing'authorizationMerchantData :: IssuingAuthorizationMerchantData
merchant_data:
issuing'authorizationMetadata :: 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.
issuing'authorizationPendingRequest :: Maybe Issuing'authorizationPendingRequest'
pending_request: The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.
issuing'authorizationRequestHistory :: [IssuingAuthorizationRequest]
request_history: History of every time `pending_request` was approved/denied, either by you directly or by Stripe (e.g. based on your `spending_controls`). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization.
issuing'authorizationStatus :: Issuing'authorizationStatus'
status: The current status of the authorization in its lifecycle.
issuing'authorizationTransactions :: [Issuing'transaction]
transactions: List of transactions associated with this authorization.
issuing'authorizationVerificationData :: IssuingAuthorizationVerificationData
verification_data:
issuing'authorizationWallet :: Maybe Text
wallet: What, if any, digital wallet was used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`.
Constraints:
- Maximum length of 5000

Instances

Instances details

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

mkIssuing'authorization Source #

Arguments

:: Int	`issuing'authorizationAmount`
-> Bool	`issuing'authorizationApproved`
-> Issuing'authorizationAuthorizationMethod'	`issuing'authorizationAuthorizationMethod`
-> [BalanceTransaction]	`issuing'authorizationBalanceTransactions`
-> Issuing'card	`issuing'authorizationCard`
-> Int	`issuing'authorizationCreated`
-> Text	`issuing'authorizationCurrency`
-> Text	`issuing'authorizationId`
-> Bool	`issuing'authorizationLivemode`
-> Int	`issuing'authorizationMerchantAmount`
-> Text	`issuing'authorizationMerchantCurrency`
-> IssuingAuthorizationMerchantData	`issuing'authorizationMerchantData`
-> Object	`issuing'authorizationMetadata`
-> [IssuingAuthorizationRequest]	`issuing'authorizationRequestHistory`
-> Issuing'authorizationStatus'	`issuing'authorizationStatus`
-> [Issuing'transaction]	`issuing'authorizationTransactions`
-> IssuingAuthorizationVerificationData	`issuing'authorizationVerificationData`
-> Issuing'authorization

Create a new Issuing'authorization with all required fields.

data Issuing'authorizationAmountDetails' Source #

Defines the object schema located at components.schemas.issuing.authorization.properties.amount_details.anyOf in the specification.

Detailed breakdown of amount components. These amounts are denominated in \`currency\` and in the smallest currency unit.

Constructors

Issuing'authorizationAmountDetails'
Fields issuing'authorizationAmountDetails'AtmFee :: Maybe Int atm_fee: The fee charged by the ATM for the cash withdrawal.

Instances

Instances details

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

mkIssuing'authorizationAmountDetails' :: Issuing'authorizationAmountDetails' Source #

Create a new Issuing'authorizationAmountDetails' with all required fields.

data Issuing'authorizationAuthorizationMethod' Source #

Defines the enum schema located at components.schemas.issuing.authorization.properties.authorization_method in the specification.

How the card details were provided.

Constructors

Issuing'authorizationAuthorizationMethod'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Issuing'authorizationAuthorizationMethod'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
Issuing'authorizationAuthorizationMethod'EnumChip	Represents the JSON value `"chip"`
Issuing'authorizationAuthorizationMethod'EnumContactless	Represents the JSON value `"contactless"`
Issuing'authorizationAuthorizationMethod'EnumKeyedIn	Represents the JSON value `"keyed_in"`
Issuing'authorizationAuthorizationMethod'EnumOnline	Represents the JSON value `"online"`
Issuing'authorizationAuthorizationMethod'EnumSwipe	Represents the JSON value `"swipe"`

Instances

Instances details

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

data Issuing'authorizationCardholder'Variants Source #

Defines the oneOf schema located at components.schemas.issuing.authorization.properties.cardholder.anyOf in the specification.

The cardholder to whom this authorization belongs.

Constructors

Issuing'authorizationCardholder'Text Text
Issuing'authorizationCardholder'Issuing'cardholder Issuing'cardholder

Instances

Instances details

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

data Issuing'authorizationPendingRequest' Source #

Defines the object schema located at components.schemas.issuing.authorization.properties.pending_request.anyOf in the specification.

The pending authorization request. This field will only be non-null during an \`issuing_authorization.request\` webhook.

Constructors

Issuing'authorizationPendingRequest'

Fields

issuing'authorizationPendingRequest'Amount :: Maybe Int
amount: The additional amount Stripe will hold if the authorization is approved, in the card's currency and in the smallest currency unit.
issuing'authorizationPendingRequest'AmountDetails :: Maybe Issuing'authorizationPendingRequest'AmountDetails'
amount_details: Detailed breakdown of amount components. These amounts are denominated in `currency` and in the smallest currency unit.
issuing'authorizationPendingRequest'Currency :: Maybe Text
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
issuing'authorizationPendingRequest'IsAmountControllable :: Maybe Bool
is_amount_controllable: If set `true`, you may provide amount to control how much to hold for the authorization.
issuing'authorizationPendingRequest'MerchantAmount :: Maybe Int
merchant_amount: The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the smallest currency unit.
issuing'authorizationPendingRequest'MerchantCurrency :: Maybe Text
merchant_currency: The local currency the merchant is requesting to authorize.

Instances

Instances details

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

mkIssuing'authorizationPendingRequest' :: Issuing'authorizationPendingRequest' Source #

Create a new Issuing'authorizationPendingRequest' with all required fields.

data Issuing'authorizationPendingRequest'AmountDetails' Source #

Defines the object schema located at components.schemas.issuing.authorization.properties.pending_request.anyOf.properties.amount_details.anyOf in the specification.

Detailed breakdown of amount components. These amounts are denominated in \`currency\` and in the smallest currency unit.

Constructors

Issuing'authorizationPendingRequest'AmountDetails'
Fields issuing'authorizationPendingRequest'AmountDetails'AtmFee :: Maybe Int atm_fee: The fee charged by the ATM for the cash withdrawal.

Instances

Instances details

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

mkIssuing'authorizationPendingRequest'AmountDetails' :: Issuing'authorizationPendingRequest'AmountDetails' Source #

Create a new Issuing'authorizationPendingRequest'AmountDetails' with all required fields.

data Issuing'authorizationStatus' Source #

Defines the enum schema located at components.schemas.issuing.authorization.properties.status in the specification.

The current status of the authorization in its lifecycle.

Constructors

Issuing'authorizationStatus'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Issuing'authorizationStatus'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
Issuing'authorizationStatus'EnumClosed	Represents the JSON value `"closed"`
Issuing'authorizationStatus'EnumPending	Represents the JSON value `"pending"`
Issuing'authorizationStatus'EnumReversed	Represents the JSON value `"reversed"`

Instances

Instances details

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