Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Issuing_Authorization

Contains the types generated from the schema Issuing_Authorization

8 types
5 values

Packagestripeapi-3.0.0.0
Exports13
LanguageHaskell2010
LicenceMIT
SourceIssuing_Authorization.hs

datadata Issuing'authorization

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
- 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 (Nullable Issuing'authorizationAmountDetails'NonNullable)
  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 (Nullable Issuing'authorizationCardholder'NonNullableVariants)
  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 (Nullable Issuing'authorizationPendingRequest'NonNullable)
  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'authorizationTreasury :: Maybe (Nullable Issuing'authorizationTreasury'NonNullable)
  treasury: Treasury details related to this authorization if it was created on a FinancialAccount.
- issuing'authorizationVerificationData :: IssuingAuthorizationVerificationData
  verification_data:
- issuing'authorizationWallet :: Maybe (Nullable Text)
  wallet: The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq Issuing'authorizationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
Show Issuing'authorizationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
FromJSON Issuing'authorizationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
ToJSON Issuing'authorizationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization

valuemkIssuing'authorization

:: 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.

datadata Issuing'authorizationAmountDetails'NonNullable

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'NonNullable
- issuing'authorizationAmountDetails'NonNullableAtmFee :: Maybe (Nullable Int)
  atm_fee: The fee charged by the ATM for the cash withdrawal.

Instances4Eq, Show, FromJSON, ToJSON

Eq Issuing'authorizationAmountDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
Show Issuing'authorizationAmountDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
FromJSON Issuing'authorizationAmountDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
ToJSON Issuing'authorizationAmountDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization

valuemkIssuing'authorizationAmountDetails'NonNullable :: Issuing'authorizationAmountDetails'NonNullable

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

datadata Issuing'authorizationAuthorizationMethod'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq Issuing'authorizationAuthorizationMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
Show Issuing'authorizationAuthorizationMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
FromJSON Issuing'authorizationAuthorizationMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
ToJSON Issuing'authorizationAuthorizationMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization

datadata Issuing'authorizationCardholder'NonNullableVariants

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'NonNullableText Text
Issuing'authorizationCardholder'NonNullableIssuing'cardholder Issuing'cardholder

Instances4Eq, Show, FromJSON, ToJSON

Eq Issuing'authorizationCardholder'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
Show Issuing'authorizationCardholder'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
FromJSON Issuing'authorizationCardholder'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
ToJSON Issuing'authorizationCardholder'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization

datadata Issuing'authorizationPendingRequest'NonNullable

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'NonNullable
- issuing'authorizationPendingRequest'NonNullableAmount :: 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'NonNullableAmountDetails :: Maybe (Nullable Issuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullable)
  amount_details: Detailed breakdown of amount components. These amounts are denominated in `currency` and in the smallest currency unit.
- issuing'authorizationPendingRequest'NonNullableCurrency :: Maybe Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- issuing'authorizationPendingRequest'NonNullableIsAmountControllable :: Maybe Bool
  is_amount_controllable: If set `true`, you may provide amount to control how much to hold for the authorization.
- issuing'authorizationPendingRequest'NonNullableMerchantAmount :: 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'NonNullableMerchantCurrency :: Maybe Text
  merchant_currency: The local currency the merchant is requesting to authorize.

Instances4Eq, Show, FromJSON, ToJSON

Eq Issuing'authorizationPendingRequest'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
Show Issuing'authorizationPendingRequest'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
FromJSON Issuing'authorizationPendingRequest'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
ToJSON Issuing'authorizationPendingRequest'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization

valuemkIssuing'authorizationPendingRequest'NonNullable :: Issuing'authorizationPendingRequest'NonNullable

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

datadata Issuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullable

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'NonNullableAmountDetails'NonNullable
- issuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullableAtmFee :: Maybe (Nullable Int)
  atm_fee: The fee charged by the ATM for the cash withdrawal.

Instances4Eq, Show, FromJSON, ToJSON

Eq Issuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
Show Issuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
FromJSON Issuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
ToJSON Issuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization

value

mkIssuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullable :: Issuing'authorizationPendingRequest'NonNullableAmountDetails'NonNullable

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

datadata Issuing'authorizationStatus'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq Issuing'authorizationStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
Show Issuing'authorizationStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
FromJSON Issuing'authorizationStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
ToJSON Issuing'authorizationStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization

datadata Issuing'authorizationTreasury'NonNullable

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

Treasury details related to this authorization if it was created on a FinancialAccount.

Constructors

Issuing'authorizationTreasury'NonNullable
- issuing'authorizationTreasury'NonNullableReceivedCredits :: Maybe [Text]
  received_credits: The array of ReceivedCredits associated with this authorization
- issuing'authorizationTreasury'NonNullableReceivedDebits :: Maybe [Text]
  received_debits: The array of ReceivedDebits associated with this authorization
- issuing'authorizationTreasury'NonNullableTransaction :: Maybe (Nullable Text)
  transaction: The Treasury Transaction associated with this authorization
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq Issuing'authorizationTreasury'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
Show Issuing'authorizationTreasury'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
FromJSON Issuing'authorizationTreasury'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization
ToJSON Issuing'authorizationTreasury'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Issuing_Authorization

valuemkIssuing'authorizationTreasury'NonNullable :: Issuing'authorizationTreasury'NonNullable

Create a new Issuing'authorizationTreasury'NonNullable with all required fields.