StripeAPI.Types.Source

Contains the types generated from the schema Source

Documentation

data 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

Fields

• sourceAchCreditTransfer :: Maybe SourceTypeAchCreditTransfer

  ach_credit_transfer

• sourceAchDebit :: Maybe SourceTypeAchDebit

  ach_debit

• sourceAcssDebit :: Maybe SourceTypeAcssDebit

  acss_debit

• sourceAlipay :: Maybe SourceTypeAlipay

  alipay

• sourceAmount :: Maybe 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 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 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 SourceOwner'

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

Instances

Eq Source

Defined in StripeAPI.Types.Source

Methods

(==) :: Source -> Source -> Bool

(/=) :: Source -> Source -> Bool

Show Source

Defined in StripeAPI.Types.Source

Methods

showsPrec :: Int -> Source -> ShowS

show :: Source -> String

showList :: [Source] -> ShowS

ToJSON Source

Defined in StripeAPI.Types.Source

Methods

toJSON :: Source -> Value

toEncoding :: Source -> Encoding

toJSONList :: [Source] -> Value

toEncodingList :: [Source] -> Encoding

FromJSON Source

Defined in StripeAPI.Types.Source

Methods

parseJSON :: Value -> Parser Source

parseJSONList :: Value -> Parser [Source]

mkSource

Arguments

:: Text

sourceClientSecret

-> Int

sourceCreated

-> Text

sourceFlow

-> Text

sourceId

-> Bool

sourceLivemode

-> Text

sourceStatus

-> SourceType'

sourceType

-> Source

Create a new Source with all required fields.

data SourceOwner'

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'

Fields

• sourceOwner'Address :: Maybe SourceOwner'Address'

  address: Owner's address.

• sourceOwner'Email :: Maybe Text

  email: Owner's email address.

  Constraints:

  • Maximum length of 5000
• sourceOwner'Name :: Maybe Text

  name: Owner's full name.

  Constraints:

  • Maximum length of 5000
• sourceOwner'Phone :: Maybe Text

  phone: Owner's phone number (including extension).

  Constraints:

  • Maximum length of 5000
• sourceOwner'VerifiedAddress :: Maybe SourceOwner'VerifiedAddress'

  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'VerifiedEmail :: Maybe 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'VerifiedName :: Maybe 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'VerifiedPhone :: Maybe 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

Instances

Eq SourceOwner'

Defined in StripeAPI.Types.Source

Methods

(==) :: SourceOwner' -> SourceOwner' -> Bool

(/=) :: SourceOwner' -> SourceOwner' -> Bool

Show SourceOwner'

Defined in StripeAPI.Types.Source

Methods

showsPrec :: Int -> SourceOwner' -> ShowS

show :: SourceOwner' -> String

showList :: [SourceOwner'] -> ShowS

ToJSON SourceOwner'

Defined in StripeAPI.Types.Source

Methods

toJSON :: SourceOwner' -> Value

toEncoding :: SourceOwner' -> Encoding

toJSONList :: [SourceOwner'] -> Value

toEncodingList :: [SourceOwner'] -> Encoding

FromJSON SourceOwner'

Defined in StripeAPI.Types.Source

Methods

parseJSON :: Value -> Parser SourceOwner'

parseJSONList :: Value -> Parser [SourceOwner']

mkSourceOwner' :: SourceOwner'

Create a new SourceOwner' with all required fields.

data SourceOwner'Address'

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

Owner\'s address.

Constructors

SourceOwner'Address'

Fields

• sourceOwner'Address'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• sourceOwner'Address'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• sourceOwner'Address'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• sourceOwner'Address'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• sourceOwner'Address'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• sourceOwner'Address'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq SourceOwner'Address'

Defined in StripeAPI.Types.Source

Methods

(==) :: SourceOwner'Address' -> SourceOwner'Address' -> Bool

(/=) :: SourceOwner'Address' -> SourceOwner'Address' -> Bool

Show SourceOwner'Address'

Defined in StripeAPI.Types.Source

Methods

showsPrec :: Int -> SourceOwner'Address' -> ShowS

show :: SourceOwner'Address' -> String

showList :: [SourceOwner'Address'] -> ShowS

ToJSON SourceOwner'Address'

Defined in StripeAPI.Types.Source

Methods

toJSON :: SourceOwner'Address' -> Value

toEncoding :: SourceOwner'Address' -> Encoding

toJSONList :: [SourceOwner'Address'] -> Value

toEncodingList :: [SourceOwner'Address'] -> Encoding

FromJSON SourceOwner'Address'

Defined in StripeAPI.Types.Source

Methods

parseJSON :: Value -> Parser SourceOwner'Address'

parseJSONList :: Value -> Parser [SourceOwner'Address']

mkSourceOwner'Address' :: SourceOwner'Address'

Create a new SourceOwner'Address' with all required fields.

data SourceOwner'VerifiedAddress'

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'VerifiedAddress'

Fields

• sourceOwner'VerifiedAddress'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• sourceOwner'VerifiedAddress'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• sourceOwner'VerifiedAddress'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• sourceOwner'VerifiedAddress'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• sourceOwner'VerifiedAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• sourceOwner'VerifiedAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq SourceOwner'VerifiedAddress'

Defined in StripeAPI.Types.Source

Methods

(==) :: SourceOwner'VerifiedAddress' -> SourceOwner'VerifiedAddress' -> Bool

(/=) :: SourceOwner'VerifiedAddress' -> SourceOwner'VerifiedAddress' -> Bool

Show SourceOwner'VerifiedAddress'

Defined in StripeAPI.Types.Source

Methods

showsPrec :: Int -> SourceOwner'VerifiedAddress' -> ShowS

show :: SourceOwner'VerifiedAddress' -> String

showList :: [SourceOwner'VerifiedAddress'] -> ShowS

ToJSON SourceOwner'VerifiedAddress'

Defined in StripeAPI.Types.Source

Methods

toJSON :: SourceOwner'VerifiedAddress' -> Value

toEncoding :: SourceOwner'VerifiedAddress' -> Encoding

toJSONList :: [SourceOwner'VerifiedAddress'] -> Value

toEncodingList :: [SourceOwner'VerifiedAddress'] -> Encoding

FromJSON SourceOwner'VerifiedAddress'

Defined in StripeAPI.Types.Source

Methods

parseJSON :: Value -> Parser SourceOwner'VerifiedAddress'

parseJSONList :: Value -> Parser [SourceOwner'VerifiedAddress']

mkSourceOwner'VerifiedAddress' :: SourceOwner'VerifiedAddress'

Create a new SourceOwner'VerifiedAddress' with all required fields.

data 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"

Instances

Eq SourceType'

Defined in StripeAPI.Types.Source

Methods

(==) :: SourceType' -> SourceType' -> Bool

(/=) :: SourceType' -> SourceType' -> Bool

Show SourceType'

Defined in StripeAPI.Types.Source

Methods

showsPrec :: Int -> SourceType' -> ShowS

show :: SourceType' -> String

showList :: [SourceType'] -> ShowS

ToJSON SourceType'

Defined in StripeAPI.Types.Source

Methods

toJSON :: SourceType' -> Value

toEncoding :: SourceType' -> Encoding

toJSONList :: [SourceType'] -> Value

toEncodingList :: [SourceType'] -> Encoding

FromJSON SourceType'

Defined in StripeAPI.Types.Source

Methods

parseJSON :: Value -> Parser SourceType'

parseJSONList :: Value -> Parser [SourceType']