Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Source

Contains the types generated from the schema Source

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceSource.hs

datadata Source

Defines the object schema located at components.schemas.source in the specification.

`Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers.

Related guides: Sources API and Sources & Customers.

Constructors

Source
- sourceAchCreditTransfer :: Maybe SourceTypeAchCreditTransfer
  ach_credit_transfer
- sourceAchDebit :: Maybe SourceTypeAchDebit
  ach_debit
- sourceAcssDebit :: Maybe SourceTypeAcssDebit
  acss_debit
- sourceAlipay :: Maybe SourceTypeAlipay
  alipay
- sourceAmount :: Maybe (Nullable Int)
  amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.
- sourceAuBecsDebit :: Maybe SourceTypeAuBecsDebit
  au_becs_debit
- sourceBancontact :: Maybe SourceTypeBancontact
  bancontact
- sourceCard :: Maybe SourceTypeCard
  card
- sourceCardPresent :: Maybe SourceTypeCardPresent
  card_present
- sourceClientSecret :: Text
  client_secret: The client secret of the source. Used for client-side retrieval using a publishable key.
  Constraints:
  - Maximum length of 5000
- sourceCodeVerification :: Maybe SourceCodeVerificationFlow
  code_verification:
- sourceCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- sourceCurrency :: Maybe (Nullable Text)
  currency: Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.
- sourceCustomer :: Maybe Text
  customer: The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
  Constraints:
  - Maximum length of 5000
- sourceEps :: Maybe SourceTypeEps
  eps
- sourceFlow :: Text
  flow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.
  Constraints:
  - Maximum length of 5000
- sourceGiropay :: Maybe SourceTypeGiropay
  giropay
- sourceId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- sourceIdeal :: Maybe SourceTypeIdeal
  ideal
- sourceKlarna :: Maybe SourceTypeKlarna
  klarna
- sourceLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- sourceMetadata :: 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.
- sourceMultibanco :: Maybe SourceTypeMultibanco
  multibanco
- sourceOwner :: Maybe (Nullable SourceOwner'NonNullable)
  owner: Information about the owner of the payment instrument that may be used or required by particular source types.
- sourceP24 :: Maybe SourceTypeP24
  p24
- sourceReceiver :: Maybe SourceReceiverFlow
  receiver:
- sourceRedirect :: Maybe SourceRedirectFlow
  redirect:
- sourceSepaDebit :: Maybe SourceTypeSepaDebit
  sepa_debit
- sourceSofort :: Maybe SourceTypeSofort
  sofort
- sourceSourceOrder :: Maybe SourceOrder
  source_order:
- sourceStatementDescriptor :: Maybe (Nullable Text)
  statement_descriptor: Extra information about a source. This will appear on your customer's statement every time you charge the source.
  Constraints:
  - Maximum length of 5000
- sourceStatus :: Text
  status: The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.
  Constraints:
  - Maximum length of 5000
- sourceThreeDSecure :: Maybe SourceTypeThreeDSecure
  three_d_secure
- sourceType :: SourceType'
  type: The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
- sourceUsage :: Maybe (Nullable Text)
  usage: Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
  Constraints:
  - Maximum length of 5000
- sourceWechat :: Maybe SourceTypeWechat
  wechat

Instances4Eq, Show, FromJSON, ToJSON

Eq SourceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
Show SourceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
FromJSON SourceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
ToJSON SourceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source

valuemkSource

:: Text
sourceClientSecret
-> Int
sourceCreated
-> Text
sourceFlow
-> Text
sourceId
-> Bool
sourceLivemode
-> Text
sourceStatus
-> SourceType'
sourceType
-> Source

Create a new Source with all required fields.

datadata SourceOwner'NonNullable

Defines the object schema located at components.schemas.source.properties.owner.anyOf in the specification.

Information about the owner of the payment instrument that may be used or required by particular source types.

Constructors

SourceOwner'NonNullable
- sourceOwner'NonNullableAddress :: Maybe (Nullable SourceOwner'NonNullableAddress'NonNullable)
  address: Owner's address.
- sourceOwner'NonNullableEmail :: Maybe (Nullable Text)
  email: Owner's email address.
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableName :: Maybe (Nullable Text)
  name: Owner's full name.
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullablePhone :: Maybe (Nullable Text)
  phone: Owner's phone number (including extension).
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableVerifiedAddress :: Maybe (Nullable SourceOwner'NonNullableVerifiedAddress'NonNullable)
  verified_address: Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
- sourceOwner'NonNullableVerifiedEmail :: Maybe (Nullable Text)
  verified_email: Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableVerifiedName :: Maybe (Nullable Text)
  verified_name: Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableVerifiedPhone :: Maybe (Nullable Text)
  verified_phone: Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq SourceOwner'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
Show SourceOwner'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
FromJSON SourceOwner'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
ToJSON SourceOwner'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source

valuemkSourceOwner'NonNullable :: SourceOwner'NonNullable

Create a new SourceOwner'NonNullable with all required fields.

datadata SourceOwner'NonNullableAddress'NonNullable

Defines the object schema located at components.schemas.source.properties.owner.anyOf.properties.address.anyOf in the specification.

Owner\'s address.

Constructors

SourceOwner'NonNullableAddress'NonNullable
- sourceOwner'NonNullableAddress'NonNullableCity :: Maybe (Nullable Text)
  city: City, district, suburb, town, or village.
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableAddress'NonNullableCountry :: Maybe (Nullable Text)
  country: Two-letter country code (ISO 3166-1 alpha-2).
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableAddress'NonNullableLine1 :: Maybe (Nullable Text)
  line1: Address line 1 (e.g., street, PO Box, or company name).
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableAddress'NonNullableLine2 :: Maybe (Nullable Text)
  line2: Address line 2 (e.g., apartment, suite, unit, or building).
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableAddress'NonNullablePostalCode :: Maybe (Nullable Text)
  postal_code: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableAddress'NonNullableState :: Maybe (Nullable Text)
  state: State, county, province, or region.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq SourceOwner'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
Show SourceOwner'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
FromJSON SourceOwner'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
ToJSON SourceOwner'NonNullableAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source

valuemkSourceOwner'NonNullableAddress'NonNullable :: SourceOwner'NonNullableAddress'NonNullable

Create a new SourceOwner'NonNullableAddress'NonNullable with all required fields.

datadata SourceOwner'NonNullableVerifiedAddress'NonNullable

Defines the object schema located at components.schemas.source.properties.owner.anyOf.properties.verified_address.anyOf in the specification.

Verified owner\'s address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constructors

SourceOwner'NonNullableVerifiedAddress'NonNullable
- sourceOwner'NonNullableVerifiedAddress'NonNullableCity :: Maybe (Nullable Text)
  city: City, district, suburb, town, or village.
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableVerifiedAddress'NonNullableCountry :: Maybe (Nullable Text)
  country: Two-letter country code (ISO 3166-1 alpha-2).
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableVerifiedAddress'NonNullableLine1 :: Maybe (Nullable Text)
  line1: Address line 1 (e.g., street, PO Box, or company name).
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableVerifiedAddress'NonNullableLine2 :: Maybe (Nullable Text)
  line2: Address line 2 (e.g., apartment, suite, unit, or building).
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableVerifiedAddress'NonNullablePostalCode :: Maybe (Nullable Text)
  postal_code: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- sourceOwner'NonNullableVerifiedAddress'NonNullableState :: Maybe (Nullable Text)
  state: State, county, province, or region.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq SourceOwner'NonNullableVerifiedAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
Show SourceOwner'NonNullableVerifiedAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
FromJSON SourceOwner'NonNullableVerifiedAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
ToJSON SourceOwner'NonNullableVerifiedAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Source

valuemkSourceOwner'NonNullableVerifiedAddress'NonNullable :: SourceOwner'NonNullableVerifiedAddress'NonNullable

Create a new SourceOwner'NonNullableVerifiedAddress'NonNullable with all required fields.

datadata SourceType'

Defines the enum schema located at components.schemas.source.properties.type in the specification.

The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.

Constructors

SourceType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
SourceType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
SourceType'EnumAchCreditTransfer
Represents the JSON value "ach_credit_transfer"
SourceType'EnumAchDebit
Represents the JSON value "ach_debit"
SourceType'EnumAcssDebit
Represents the JSON value "acss_debit"
SourceType'EnumAlipay
Represents the JSON value "alipay"
SourceType'EnumAuBecsDebit
Represents the JSON value "au_becs_debit"
SourceType'EnumBancontact
Represents the JSON value "bancontact"
SourceType'EnumCard
Represents the JSON value "card"
SourceType'EnumCardPresent
Represents the JSON value "card_present"
SourceType'EnumEps
Represents the JSON value "eps"
SourceType'EnumGiropay
Represents the JSON value "giropay"
SourceType'EnumIdeal
Represents the JSON value "ideal"
SourceType'EnumKlarna
Represents the JSON value "klarna"
SourceType'EnumMultibanco
Represents the JSON value "multibanco"
SourceType'EnumP24
Represents the JSON value "p24"
SourceType'EnumSepaDebit
Represents the JSON value "sepa_debit"
SourceType'EnumSofort
Represents the JSON value "sofort"
SourceType'EnumThreeDSecure
Represents the JSON value "three_d_secure"
SourceType'EnumWechat
Represents the JSON value "wechat"

Instances4Eq, Show, FromJSON, ToJSON

Eq SourceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
Show SourceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
FromJSON SourceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Source
ToJSON SourceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Source