StripeAPI.Types.PaymentSource

Contains the types generated from the schema PaymentSource

Documentation

data PaymentSource

Defines the object schema located at components.schemas.payment_source.anyOf in the specification.

Constructors

PaymentSource

Fields

• paymentSourceAccount :: Maybe PaymentSourceAccount'Variants

  account: The ID of the account that the bank account is associated with.

• paymentSourceAccountHolderName :: Maybe Text

  account_holder_name: The name of the person or business that owns the bank account.

  Constraints:

  • Maximum length of 5000
• paymentSourceAccountHolderType :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• paymentSourceAchCreditTransfer :: Maybe SourceTypeAchCreditTransfer

  ach_credit_transfer

• paymentSourceAchDebit :: Maybe SourceTypeAchDebit

  ach_debit

• paymentSourceAcssDebit :: Maybe SourceTypeAcssDebit

  acss_debit

• paymentSourceActive :: Maybe Bool

  active: True when this bitcoin receiver has received a non-zero amount of bitcoin.

• paymentSourceAddressCity :: Maybe Text

  address_city: City/District/Suburb/Town/Village.

  Constraints:

  • Maximum length of 5000
• paymentSourceAddressCountry :: Maybe Text

  address_country: Billing address country, if provided when creating card.

  Constraints:

  • Maximum length of 5000
• paymentSourceAddressLine1 :: Maybe Text

  address_line1: Address line 1 (Street address/PO Box/Company name).

  Constraints:

  • Maximum length of 5000
• paymentSourceAddressLine1Check :: Maybe Text

  address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• paymentSourceAddressLine2 :: Maybe Text

  address_line2: Address line 2 (Apartment/Suite/Unit/Building).

  Constraints:

  • Maximum length of 5000
• paymentSourceAddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• paymentSourceAddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• paymentSourceAddressZipCheck :: Maybe Text

  address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• paymentSourceAlipay :: Maybe SourceTypeAlipay

  alipay

• paymentSourceAmount :: Maybe Int

  amount: The amount of `currency` that you are collecting as payment.

• paymentSourceAmountReceived :: Maybe Int

  amount_received: The amount of `currency` to which `bitcoin_amount_received` has been converted.

• paymentSourceAuBecsDebit :: Maybe SourceTypeAuBecsDebit

  au_becs_debit

• paymentSourceAvailablePayoutMethods :: Maybe [PaymentSourceAvailablePayoutMethods']

  available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

• paymentSourceBancontact :: Maybe SourceTypeBancontact

  bancontact

• paymentSourceBankName :: Maybe Text

  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

  Constraints:

  • Maximum length of 5000
• paymentSourceBitcoinAmount :: Maybe Int

  bitcoin_amount: The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

• paymentSourceBitcoinAmountReceived :: Maybe Int

  bitcoin_amount_received: The amount of bitcoin that has been sent by the customer to this receiver.

• paymentSourceBitcoinUri :: Maybe Text

  bitcoin_uri: This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets).

  Constraints:

  • Maximum length of 5000
• paymentSourceBrand :: Maybe Text

  brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile :: Maybe PaymentSourceBusinessProfile'

  business_profile: Business information about the account.

• paymentSourceBusinessType :: Maybe PaymentSourceBusinessType'

  business_type: The business type.

• paymentSourceCapabilities :: Maybe AccountCapabilities

  capabilities:

• paymentSourceCard :: Maybe SourceTypeCard

  card

• paymentSourceCardPresent :: Maybe SourceTypeCardPresent

  card_present

• paymentSourceChargesEnabled :: Maybe Bool

  charges_enabled: Whether the account can create live charges.

• paymentSourceClientSecret :: Maybe Text

  client_secret: The client secret of the source. Used for client-side retrieval using a publishable key.

  Constraints:

  • Maximum length of 5000
• paymentSourceCodeVerification :: Maybe SourceCodeVerificationFlow

  code_verification:

• paymentSourceCompany :: Maybe LegalEntityCompany

  company:

• paymentSourceController :: Maybe AccountController

  controller:

• paymentSourceCountry :: Maybe Text

  country: The account's country.

  Constraints:

  • Maximum length of 5000
• paymentSourceCreated :: Maybe Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• paymentSourceCurrency :: Maybe Text

  currency: Three-letter ISO code for the currency paid out to the bank account.

• paymentSourceCustomer :: Maybe PaymentSourceCustomer'Variants

  customer: The ID of the customer associated with this Alipay Account.

• paymentSourceCvcCheck :: Maybe Text

  cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

  Constraints:

  • Maximum length of 5000
• paymentSourceDefaultCurrency :: Maybe Text

  default_currency: Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.

  Constraints:

  • Maximum length of 5000
• paymentSourceDefaultForCurrency :: Maybe Bool

  default_for_currency: Whether this bank account is the default external account for its currency.

• paymentSourceDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• paymentSourceDetailsSubmitted :: Maybe Bool

  details_submitted: Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.

• paymentSourceDynamicLast4 :: Maybe Text

  dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.

  Constraints:

  • Maximum length of 5000
• paymentSourceEmail :: Maybe Text

  email: An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.

  Constraints:

  • Maximum length of 5000
• paymentSourceEps :: Maybe SourceTypeEps

  eps

• paymentSourceExpMonth :: Maybe Int

  exp_month: Two-digit number representing the card's expiration month.

• paymentSourceExpYear :: Maybe Int

  exp_year: Four-digit number representing the card's expiration year.

• paymentSourceExternalAccounts :: Maybe PaymentSourceExternalAccounts'

  external_accounts: External accounts (bank accounts and debit cards) currently attached to this account

• paymentSourceFilled :: Maybe Bool

  filled: This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver.

• paymentSourceFingerprint :: Maybe Text

  fingerprint: Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account.

  Constraints:

  • Maximum length of 5000
• paymentSourceFlow :: Maybe Text

  flow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.

  Constraints:

  • Maximum length of 5000
• paymentSourceFunding :: Maybe Text

  funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

  Constraints:

  • Maximum length of 5000
• paymentSourceGiropay :: Maybe SourceTypeGiropay

  giropay

• paymentSourceId :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• paymentSourceIdeal :: Maybe SourceTypeIdeal

  ideal

• paymentSourceInboundAddress :: Maybe Text

  inbound_address: A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.

  Constraints:

  • Maximum length of 5000
• paymentSourceIndividual :: Maybe Person

  individual: This is an object representing a person associated with a Stripe account.

  A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the Standard onboarding or Express onboarding documentation for information about platform pre-filling and account onboarding steps.

  Related guide: Handling Identity Verification with the API.

• paymentSourceKlarna :: Maybe SourceTypeKlarna

  klarna

• paymentSourceLast4 :: Maybe Text

  last4: The last four digits of the bank account number.

  Constraints:

  • Maximum length of 5000
• paymentSourceLivemode :: Maybe Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

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

• paymentSourceMultibanco :: Maybe SourceTypeMultibanco

  multibanco

• paymentSourceName :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• paymentSourceObject :: Maybe PaymentSourceObject'

  object: String representing the object's type. Objects of the same type share the same value.

• paymentSourceOwner :: Maybe PaymentSourceOwner'

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

• paymentSourceP24 :: Maybe SourceTypeP24

  p24

• paymentSourcePayment :: Maybe Text

  payment: The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.

  Constraints:

  • Maximum length of 5000
• paymentSourcePaymentAmount :: Maybe Int

  payment_amount: If the Alipay account object is not reusable, the exact amount that you can create a charge for.

• paymentSourcePaymentCurrency :: Maybe Text

  payment_currency: If the Alipay account object is not reusable, the exact currency that you can create a charge for.

• paymentSourcePayoutsEnabled :: Maybe Bool

  payouts_enabled: Whether Stripe can send payouts to this account.

• paymentSourceReceiver :: Maybe SourceReceiverFlow

  receiver:

• paymentSourceRecipient :: Maybe PaymentSourceRecipient'Variants

  recipient: The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

• paymentSourceRedirect :: Maybe SourceRedirectFlow

  redirect:

• paymentSourceRefundAddress :: Maybe Text

  refund_address: The refund address of this bitcoin receiver.

  Constraints:

  • Maximum length of 5000
• paymentSourceRequirements :: Maybe AccountRequirements

  requirements:

• paymentSourceReusable :: Maybe Bool

  reusable: True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment.

• paymentSourceRoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• paymentSourceSepaDebit :: Maybe SourceTypeSepaDebit

  sepa_debit

• paymentSourceSettings :: Maybe PaymentSourceSettings'

  settings: Options for customizing how the account functions within Stripe.

• paymentSourceSofort :: Maybe SourceTypeSofort

  sofort

• paymentSourceSourceOrder :: Maybe SourceOrder

  source_order:

• paymentSourceStatementDescriptor :: 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
• paymentSourceStatus :: Maybe Text

  status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

  For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

  Constraints:

  • Maximum length of 5000
• paymentSourceThreeDSecure :: Maybe SourceTypeThreeDSecure

  three_d_secure

• paymentSourceTokenizationMethod :: Maybe Text

  tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.

  Constraints:

  • Maximum length of 5000
• paymentSourceTosAcceptance :: Maybe AccountTosAcceptance

  tos_acceptance:

• paymentSourceTransactions :: Maybe PaymentSourceTransactions'

  transactions: A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key.

• paymentSourceType :: Maybe PaymentSourceType'

  type: The Stripe account type. Can be `standard`, `express`, or `custom`.

• paymentSourceUncapturedFunds :: Maybe Bool

  uncaptured_funds: This receiver contains uncaptured funds that can be used for a payment or refunded.

• paymentSourceUsage :: 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
• paymentSourceUsed :: Maybe Bool

  used: Whether this Alipay account object has ever been used for a payment.

• paymentSourceUsedForPayment :: Maybe Bool

  used_for_payment: Indicate if this source is used for payment.

• paymentSourceUsername :: Maybe Text

  username: The username for the Alipay account.

  Constraints:

  • Maximum length of 5000
• paymentSourceWechat :: Maybe SourceTypeWechat

  wechat

Instances

Eq PaymentSource

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSource -> PaymentSource -> Bool

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

Show PaymentSource

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSource -> ShowS

show :: PaymentSource -> String

showList :: [PaymentSource] -> ShowS

ToJSON PaymentSource

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSource -> Value

toEncoding :: PaymentSource -> Encoding

toJSONList :: [PaymentSource] -> Value

toEncodingList :: [PaymentSource] -> Encoding

FromJSON PaymentSource

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSource

parseJSONList :: Value -> Parser [PaymentSource]

mkPaymentSource :: PaymentSource

Create a new PaymentSource with all required fields.

data PaymentSourceAccount'Variants

Defines the oneOf schema located at components.schemas.payment_source.anyOf.properties.account.anyOf in the specification.

The ID of the account that the bank account is associated with.

Constructors

PaymentSourceAccount'Text Text

PaymentSourceAccount'Account Account

Instances

Eq PaymentSourceAccount'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceAccount'Variants -> PaymentSourceAccount'Variants -> Bool

(/=) :: PaymentSourceAccount'Variants -> PaymentSourceAccount'Variants -> Bool

Show PaymentSourceAccount'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceAccount'Variants -> ShowS

show :: PaymentSourceAccount'Variants -> String

showList :: [PaymentSourceAccount'Variants] -> ShowS

ToJSON PaymentSourceAccount'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceAccount'Variants -> Value

toEncoding :: PaymentSourceAccount'Variants -> Encoding

toJSONList :: [PaymentSourceAccount'Variants] -> Value

toEncodingList :: [PaymentSourceAccount'Variants] -> Encoding

FromJSON PaymentSourceAccount'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceAccount'Variants

parseJSONList :: Value -> Parser [PaymentSourceAccount'Variants]

data PaymentSourceAvailablePayoutMethods'

Defines the enum schema located at components.schemas.payment_source.anyOf.properties.available_payout_methods.items in the specification.

Constructors

PaymentSourceAvailablePayoutMethods'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentSourceAvailablePayoutMethods'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentSourceAvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

PaymentSourceAvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq PaymentSourceAvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceAvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceAvailablePayoutMethods' -> ShowS

show :: PaymentSourceAvailablePayoutMethods' -> String

showList :: [PaymentSourceAvailablePayoutMethods'] -> ShowS

ToJSON PaymentSourceAvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceAvailablePayoutMethods' -> Value

toEncoding :: PaymentSourceAvailablePayoutMethods' -> Encoding

toJSONList :: [PaymentSourceAvailablePayoutMethods'] -> Value

toEncodingList :: [PaymentSourceAvailablePayoutMethods'] -> Encoding

FromJSON PaymentSourceAvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceAvailablePayoutMethods'

parseJSONList :: Value -> Parser [PaymentSourceAvailablePayoutMethods']

data PaymentSourceBusinessProfile'

Defines the object schema located at components.schemas.payment_source.anyOf.properties.business_profile.anyOf in the specification.

Business information about the account.

Constructors

PaymentSourceBusinessProfile'

Fields

• paymentSourceBusinessProfile'Mcc :: Maybe Text

  mcc: The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.

  Constraints:

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

  name: The customer-facing business name.

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile'ProductDescription :: Maybe Text

  product_description: Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.

  Constraints:

  • Maximum length of 40000
• paymentSourceBusinessProfile'SupportAddress :: Maybe PaymentSourceBusinessProfile'SupportAddress'

  support_address: A publicly available mailing address for sending support issues to.

• paymentSourceBusinessProfile'SupportEmail :: Maybe Text

  support_email: A publicly available email address for sending support issues to.

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile'SupportPhone :: Maybe Text

  support_phone: A publicly available phone number to call with support issues.

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile'SupportUrl :: Maybe Text

  support_url: A publicly available website for handling support issues.

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile'Url :: Maybe Text

  url: The business's publicly available website.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentSourceBusinessProfile'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceBusinessProfile'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceBusinessProfile' -> ShowS

show :: PaymentSourceBusinessProfile' -> String

showList :: [PaymentSourceBusinessProfile'] -> ShowS

ToJSON PaymentSourceBusinessProfile'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceBusinessProfile' -> Value

toEncoding :: PaymentSourceBusinessProfile' -> Encoding

toJSONList :: [PaymentSourceBusinessProfile'] -> Value

toEncodingList :: [PaymentSourceBusinessProfile'] -> Encoding

FromJSON PaymentSourceBusinessProfile'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceBusinessProfile'

parseJSONList :: Value -> Parser [PaymentSourceBusinessProfile']

mkPaymentSourceBusinessProfile' :: PaymentSourceBusinessProfile'

Create a new PaymentSourceBusinessProfile' with all required fields.

data PaymentSourceBusinessProfile'SupportAddress'

Defines the object schema located at components.schemas.payment_source.anyOf.properties.business_profile.anyOf.properties.support_address.anyOf in the specification.

A publicly available mailing address for sending support issues to.

Constructors

PaymentSourceBusinessProfile'SupportAddress'

Fields

• paymentSourceBusinessProfile'SupportAddress'City :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile'SupportAddress'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
• paymentSourceBusinessProfile'SupportAddress'Line1 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile'SupportAddress'Line2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile'SupportAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• paymentSourceBusinessProfile'SupportAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentSourceBusinessProfile'SupportAddress'

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceBusinessProfile'SupportAddress' -> PaymentSourceBusinessProfile'SupportAddress' -> Bool

(/=) :: PaymentSourceBusinessProfile'SupportAddress' -> PaymentSourceBusinessProfile'SupportAddress' -> Bool

Show PaymentSourceBusinessProfile'SupportAddress'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceBusinessProfile'SupportAddress' -> ShowS

show :: PaymentSourceBusinessProfile'SupportAddress' -> String

showList :: [PaymentSourceBusinessProfile'SupportAddress'] -> ShowS

ToJSON PaymentSourceBusinessProfile'SupportAddress'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceBusinessProfile'SupportAddress' -> Value

toEncoding :: PaymentSourceBusinessProfile'SupportAddress' -> Encoding

toJSONList :: [PaymentSourceBusinessProfile'SupportAddress'] -> Value

toEncodingList :: [PaymentSourceBusinessProfile'SupportAddress'] -> Encoding

FromJSON PaymentSourceBusinessProfile'SupportAddress'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceBusinessProfile'SupportAddress'

parseJSONList :: Value -> Parser [PaymentSourceBusinessProfile'SupportAddress']

mkPaymentSourceBusinessProfile'SupportAddress' :: PaymentSourceBusinessProfile'SupportAddress'

Create a new PaymentSourceBusinessProfile'SupportAddress' with all required fields.

data PaymentSourceBusinessType'

Defines the enum schema located at components.schemas.payment_source.anyOf.properties.business_type in the specification.

The business type.

Constructors

PaymentSourceBusinessType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentSourceBusinessType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentSourceBusinessType'EnumCompany

Represents the JSON value "company"

PaymentSourceBusinessType'EnumGovernmentEntity

Represents the JSON value "government_entity"

PaymentSourceBusinessType'EnumIndividual

Represents the JSON value "individual"

PaymentSourceBusinessType'EnumNonProfit

Represents the JSON value "non_profit"

Instances

Eq PaymentSourceBusinessType'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceBusinessType'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceBusinessType' -> ShowS

show :: PaymentSourceBusinessType' -> String

showList :: [PaymentSourceBusinessType'] -> ShowS

ToJSON PaymentSourceBusinessType'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceBusinessType' -> Value

toEncoding :: PaymentSourceBusinessType' -> Encoding

toJSONList :: [PaymentSourceBusinessType'] -> Value

toEncodingList :: [PaymentSourceBusinessType'] -> Encoding

FromJSON PaymentSourceBusinessType'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceBusinessType'

parseJSONList :: Value -> Parser [PaymentSourceBusinessType']

data PaymentSourceCustomer'Variants

Defines the oneOf schema located at components.schemas.payment_source.anyOf.properties.customer.anyOf in the specification.

The ID of the customer associated with this Alipay Account.

Constructors

PaymentSourceCustomer'Text Text

PaymentSourceCustomer'Customer Customer

PaymentSourceCustomer'DeletedCustomer DeletedCustomer

Instances

Eq PaymentSourceCustomer'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceCustomer'Variants -> PaymentSourceCustomer'Variants -> Bool

(/=) :: PaymentSourceCustomer'Variants -> PaymentSourceCustomer'Variants -> Bool

Show PaymentSourceCustomer'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceCustomer'Variants -> ShowS

show :: PaymentSourceCustomer'Variants -> String

showList :: [PaymentSourceCustomer'Variants] -> ShowS

ToJSON PaymentSourceCustomer'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceCustomer'Variants -> Value

toEncoding :: PaymentSourceCustomer'Variants -> Encoding

toJSONList :: [PaymentSourceCustomer'Variants] -> Value

toEncodingList :: [PaymentSourceCustomer'Variants] -> Encoding

FromJSON PaymentSourceCustomer'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceCustomer'Variants

parseJSONList :: Value -> Parser [PaymentSourceCustomer'Variants]

data PaymentSourceExternalAccounts'

Defines the object schema located at components.schemas.payment_source.anyOf.properties.external_accounts in the specification.

External accounts (bank accounts and debit cards) currently attached to this account

Constructors

PaymentSourceExternalAccounts'

Fields

• paymentSourceExternalAccounts'Data :: [PaymentSourceExternalAccounts'Data']

  data: The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.

• paymentSourceExternalAccounts'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• paymentSourceExternalAccounts'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentSourceExternalAccounts'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceExternalAccounts'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceExternalAccounts' -> ShowS

show :: PaymentSourceExternalAccounts' -> String

showList :: [PaymentSourceExternalAccounts'] -> ShowS

ToJSON PaymentSourceExternalAccounts'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceExternalAccounts' -> Value

toEncoding :: PaymentSourceExternalAccounts' -> Encoding

toJSONList :: [PaymentSourceExternalAccounts'] -> Value

toEncodingList :: [PaymentSourceExternalAccounts'] -> Encoding

FromJSON PaymentSourceExternalAccounts'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceExternalAccounts'

parseJSONList :: Value -> Parser [PaymentSourceExternalAccounts']

mkPaymentSourceExternalAccounts'

Arguments

:: [PaymentSourceExternalAccounts'Data']

paymentSourceExternalAccounts'Data

-> Bool

paymentSourceExternalAccounts'HasMore

-> Text

paymentSourceExternalAccounts'Url

-> PaymentSourceExternalAccounts'

Create a new PaymentSourceExternalAccounts' with all required fields.

data PaymentSourceExternalAccounts'Data'

Defines the object schema located at components.schemas.payment_source.anyOf.properties.external_accounts.properties.data.items.anyOf in the specification.

Constructors

PaymentSourceExternalAccounts'Data'

Fields

• paymentSourceExternalAccounts'Data'Account :: Maybe PaymentSourceExternalAccounts'Data'Account'Variants

  account: The ID of the account that the bank account is associated with.

• paymentSourceExternalAccounts'Data'AccountHolderName :: Maybe Text

  account_holder_name: The name of the person or business that owns the bank account.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AccountHolderType :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AddressCity :: Maybe Text

  address_city: City/District/Suburb/Town/Village.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AddressCountry :: Maybe Text

  address_country: Billing address country, if provided when creating card.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AddressLine1 :: Maybe Text

  address_line1: Address line 1 (Street address/PO Box/Company name).

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AddressLine1Check :: Maybe Text

  address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AddressLine2 :: Maybe Text

  address_line2: Address line 2 (Apartment/Suite/Unit/Building).

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AddressZipCheck :: Maybe Text

  address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'AvailablePayoutMethods :: Maybe [PaymentSourceExternalAccounts'Data'AvailablePayoutMethods']

  available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

• paymentSourceExternalAccounts'Data'BankName :: Maybe Text

  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Brand :: Maybe Text

  brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Country :: Maybe Text

  country: Two-letter ISO code representing the country the bank account is located in.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Currency :: Maybe Text

  currency: Three-letter ISO code for the currency paid out to the bank account.

• paymentSourceExternalAccounts'Data'Customer :: Maybe PaymentSourceExternalAccounts'Data'Customer'Variants

  customer: The ID of the customer that the bank account is associated with.

• paymentSourceExternalAccounts'Data'CvcCheck :: Maybe Text

  cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'DefaultForCurrency :: Maybe Bool

  default_for_currency: Whether this bank account is the default external account for its currency.

• paymentSourceExternalAccounts'Data'DynamicLast4 :: Maybe Text

  dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'ExpMonth :: Maybe Int

  exp_month: Two-digit number representing the card's expiration month.

• paymentSourceExternalAccounts'Data'ExpYear :: Maybe Int

  exp_year: Four-digit number representing the card's expiration year.

• paymentSourceExternalAccounts'Data'Fingerprint :: Maybe Text

  fingerprint: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Funding :: Maybe Text

  funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Last4 :: Maybe Text

  last4: The last four digits of the bank account number.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Metadata :: 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.

• paymentSourceExternalAccounts'Data'Name :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Object :: Maybe PaymentSourceExternalAccounts'Data'Object'

  object: String representing the object's type. Objects of the same type share the same value.

• paymentSourceExternalAccounts'Data'Recipient :: Maybe PaymentSourceExternalAccounts'Data'Recipient'Variants

  recipient: The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

• paymentSourceExternalAccounts'Data'RoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'Status :: Maybe Text

  status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

  For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

  Constraints:

  • Maximum length of 5000
• paymentSourceExternalAccounts'Data'TokenizationMethod :: Maybe Text

  tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentSourceExternalAccounts'Data'

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceExternalAccounts'Data' -> PaymentSourceExternalAccounts'Data' -> Bool

(/=) :: PaymentSourceExternalAccounts'Data' -> PaymentSourceExternalAccounts'Data' -> Bool

Show PaymentSourceExternalAccounts'Data'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceExternalAccounts'Data' -> ShowS

show :: PaymentSourceExternalAccounts'Data' -> String

showList :: [PaymentSourceExternalAccounts'Data'] -> ShowS

ToJSON PaymentSourceExternalAccounts'Data'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceExternalAccounts'Data' -> Value

toEncoding :: PaymentSourceExternalAccounts'Data' -> Encoding

toJSONList :: [PaymentSourceExternalAccounts'Data'] -> Value

toEncodingList :: [PaymentSourceExternalAccounts'Data'] -> Encoding

FromJSON PaymentSourceExternalAccounts'Data'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceExternalAccounts'Data'

parseJSONList :: Value -> Parser [PaymentSourceExternalAccounts'Data']

mkPaymentSourceExternalAccounts'Data' :: PaymentSourceExternalAccounts'Data'

Create a new PaymentSourceExternalAccounts'Data' with all required fields.

data PaymentSourceExternalAccounts'Data'Account'Variants

Defines the oneOf schema located at components.schemas.payment_source.anyOf.properties.external_accounts.properties.data.items.anyOf.properties.account.anyOf in the specification.

The ID of the account that the bank account is associated with.

Constructors

PaymentSourceExternalAccounts'Data'Account'Text Text

PaymentSourceExternalAccounts'Data'Account'Account Account

Instances

Eq PaymentSourceExternalAccounts'Data'Account'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceExternalAccounts'Data'Account'Variants -> PaymentSourceExternalAccounts'Data'Account'Variants -> Bool

(/=) :: PaymentSourceExternalAccounts'Data'Account'Variants -> PaymentSourceExternalAccounts'Data'Account'Variants -> Bool

Show PaymentSourceExternalAccounts'Data'Account'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceExternalAccounts'Data'Account'Variants -> ShowS

show :: PaymentSourceExternalAccounts'Data'Account'Variants -> String

showList :: [PaymentSourceExternalAccounts'Data'Account'Variants] -> ShowS

ToJSON PaymentSourceExternalAccounts'Data'Account'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceExternalAccounts'Data'Account'Variants -> Value

toEncoding :: PaymentSourceExternalAccounts'Data'Account'Variants -> Encoding

toJSONList :: [PaymentSourceExternalAccounts'Data'Account'Variants] -> Value

toEncodingList :: [PaymentSourceExternalAccounts'Data'Account'Variants] -> Encoding

FromJSON PaymentSourceExternalAccounts'Data'Account'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceExternalAccounts'Data'Account'Variants

parseJSONList :: Value -> Parser [PaymentSourceExternalAccounts'Data'Account'Variants]

data PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'

Defines the enum schema located at components.schemas.payment_source.anyOf.properties.external_accounts.properties.data.items.anyOf.properties.available_payout_methods.items in the specification.

Constructors

PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceExternalAccounts'Data'AvailablePayoutMethods' -> PaymentSourceExternalAccounts'Data'AvailablePayoutMethods' -> Bool

(/=) :: PaymentSourceExternalAccounts'Data'AvailablePayoutMethods' -> PaymentSourceExternalAccounts'Data'AvailablePayoutMethods' -> Bool

Show PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceExternalAccounts'Data'AvailablePayoutMethods' -> ShowS

show :: PaymentSourceExternalAccounts'Data'AvailablePayoutMethods' -> String

showList :: [PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'] -> ShowS

ToJSON PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceExternalAccounts'Data'AvailablePayoutMethods' -> Value

toEncoding :: PaymentSourceExternalAccounts'Data'AvailablePayoutMethods' -> Encoding

toJSONList :: [PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'] -> Value

toEncodingList :: [PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'] -> Encoding

FromJSON PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceExternalAccounts'Data'AvailablePayoutMethods'

parseJSONList :: Value -> Parser [PaymentSourceExternalAccounts'Data'AvailablePayoutMethods']

data PaymentSourceExternalAccounts'Data'Customer'Variants

Defines the oneOf schema located at components.schemas.payment_source.anyOf.properties.external_accounts.properties.data.items.anyOf.properties.customer.anyOf in the specification.

The ID of the customer that the bank account is associated with.

Constructors

PaymentSourceExternalAccounts'Data'Customer'Text Text

PaymentSourceExternalAccounts'Data'Customer'Customer Customer

PaymentSourceExternalAccounts'Data'Customer'DeletedCustomer DeletedCustomer

Instances

Eq PaymentSourceExternalAccounts'Data'Customer'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceExternalAccounts'Data'Customer'Variants -> PaymentSourceExternalAccounts'Data'Customer'Variants -> Bool

(/=) :: PaymentSourceExternalAccounts'Data'Customer'Variants -> PaymentSourceExternalAccounts'Data'Customer'Variants -> Bool

Show PaymentSourceExternalAccounts'Data'Customer'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceExternalAccounts'Data'Customer'Variants -> ShowS

show :: PaymentSourceExternalAccounts'Data'Customer'Variants -> String

showList :: [PaymentSourceExternalAccounts'Data'Customer'Variants] -> ShowS

ToJSON PaymentSourceExternalAccounts'Data'Customer'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceExternalAccounts'Data'Customer'Variants -> Value

toEncoding :: PaymentSourceExternalAccounts'Data'Customer'Variants -> Encoding

toJSONList :: [PaymentSourceExternalAccounts'Data'Customer'Variants] -> Value

toEncodingList :: [PaymentSourceExternalAccounts'Data'Customer'Variants] -> Encoding

FromJSON PaymentSourceExternalAccounts'Data'Customer'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceExternalAccounts'Data'Customer'Variants

parseJSONList :: Value -> Parser [PaymentSourceExternalAccounts'Data'Customer'Variants]

data PaymentSourceExternalAccounts'Data'Object'

Defines the enum schema located at components.schemas.payment_source.anyOf.properties.external_accounts.properties.data.items.anyOf.properties.object in the specification.

String representing the object's type. Objects of the same type share the same value.

Constructors

PaymentSourceExternalAccounts'Data'Object'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentSourceExternalAccounts'Data'Object'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentSourceExternalAccounts'Data'Object'EnumBankAccount

Represents the JSON value "bank_account"

Instances

Eq PaymentSourceExternalAccounts'Data'Object'

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceExternalAccounts'Data'Object' -> PaymentSourceExternalAccounts'Data'Object' -> Bool

(/=) :: PaymentSourceExternalAccounts'Data'Object' -> PaymentSourceExternalAccounts'Data'Object' -> Bool

Show PaymentSourceExternalAccounts'Data'Object'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceExternalAccounts'Data'Object' -> ShowS

show :: PaymentSourceExternalAccounts'Data'Object' -> String

showList :: [PaymentSourceExternalAccounts'Data'Object'] -> ShowS

ToJSON PaymentSourceExternalAccounts'Data'Object'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceExternalAccounts'Data'Object' -> Value

toEncoding :: PaymentSourceExternalAccounts'Data'Object' -> Encoding

toJSONList :: [PaymentSourceExternalAccounts'Data'Object'] -> Value

toEncodingList :: [PaymentSourceExternalAccounts'Data'Object'] -> Encoding

FromJSON PaymentSourceExternalAccounts'Data'Object'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceExternalAccounts'Data'Object'

parseJSONList :: Value -> Parser [PaymentSourceExternalAccounts'Data'Object']

data PaymentSourceExternalAccounts'Data'Recipient'Variants

Defines the oneOf schema located at components.schemas.payment_source.anyOf.properties.external_accounts.properties.data.items.anyOf.properties.recipient.anyOf in the specification.

The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

Constructors

PaymentSourceExternalAccounts'Data'Recipient'Text Text

PaymentSourceExternalAccounts'Data'Recipient'Recipient Recipient

Instances

Eq PaymentSourceExternalAccounts'Data'Recipient'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceExternalAccounts'Data'Recipient'Variants -> PaymentSourceExternalAccounts'Data'Recipient'Variants -> Bool

(/=) :: PaymentSourceExternalAccounts'Data'Recipient'Variants -> PaymentSourceExternalAccounts'Data'Recipient'Variants -> Bool

Show PaymentSourceExternalAccounts'Data'Recipient'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceExternalAccounts'Data'Recipient'Variants -> ShowS

show :: PaymentSourceExternalAccounts'Data'Recipient'Variants -> String

showList :: [PaymentSourceExternalAccounts'Data'Recipient'Variants] -> ShowS

ToJSON PaymentSourceExternalAccounts'Data'Recipient'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceExternalAccounts'Data'Recipient'Variants -> Value

toEncoding :: PaymentSourceExternalAccounts'Data'Recipient'Variants -> Encoding

toJSONList :: [PaymentSourceExternalAccounts'Data'Recipient'Variants] -> Value

toEncodingList :: [PaymentSourceExternalAccounts'Data'Recipient'Variants] -> Encoding

FromJSON PaymentSourceExternalAccounts'Data'Recipient'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceExternalAccounts'Data'Recipient'Variants

parseJSONList :: Value -> Parser [PaymentSourceExternalAccounts'Data'Recipient'Variants]

data PaymentSourceObject'

Defines the enum schema located at components.schemas.payment_source.anyOf.properties.object in the specification.

String representing the object's type. Objects of the same type share the same value.

Constructors

PaymentSourceObject'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentSourceObject'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentSourceObject'EnumAccount

Represents the JSON value "account"

Instances

Eq PaymentSourceObject'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceObject'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceObject' -> ShowS

show :: PaymentSourceObject' -> String

showList :: [PaymentSourceObject'] -> ShowS

ToJSON PaymentSourceObject'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceObject' -> Value

toEncoding :: PaymentSourceObject' -> Encoding

toJSONList :: [PaymentSourceObject'] -> Value

toEncodingList :: [PaymentSourceObject'] -> Encoding

FromJSON PaymentSourceObject'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceObject'

parseJSONList :: Value -> Parser [PaymentSourceObject']

data PaymentSourceOwner'

Defines the object schema located at components.schemas.payment_source.anyOf.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

PaymentSourceOwner'

Fields

• paymentSourceOwner'Address :: Maybe PaymentSourceOwner'Address'

  address: Owner's address.

• paymentSourceOwner'Email :: Maybe Text

  email: Owner's email address.

  Constraints:

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

  name: Owner's full name.

  Constraints:

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

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

  Constraints:

  • Maximum length of 5000
• paymentSourceOwner'VerifiedAddress :: Maybe PaymentSourceOwner'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.

• paymentSourceOwner'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
• paymentSourceOwner'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
• paymentSourceOwner'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 PaymentSourceOwner'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceOwner'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceOwner' -> ShowS

show :: PaymentSourceOwner' -> String

showList :: [PaymentSourceOwner'] -> ShowS

ToJSON PaymentSourceOwner'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceOwner' -> Value

toEncoding :: PaymentSourceOwner' -> Encoding

toJSONList :: [PaymentSourceOwner'] -> Value

toEncodingList :: [PaymentSourceOwner'] -> Encoding

FromJSON PaymentSourceOwner'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceOwner'

parseJSONList :: Value -> Parser [PaymentSourceOwner']

mkPaymentSourceOwner' :: PaymentSourceOwner'

Create a new PaymentSourceOwner' with all required fields.

data PaymentSourceOwner'Address'

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

Owner\'s address.

Constructors

PaymentSourceOwner'Address'

Fields

• paymentSourceOwner'Address'City :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• paymentSourceOwner'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
• paymentSourceOwner'Address'Line1 :: Maybe Text

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

  Constraints:

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

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

  Constraints:

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

  postal_code: ZIP or postal code.

  Constraints:

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

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentSourceOwner'Address'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceOwner'Address'

Defined in StripeAPI.Types.PaymentSource

Methods

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

show :: PaymentSourceOwner'Address' -> String

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

ToJSON PaymentSourceOwner'Address'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceOwner'Address' -> Value

toEncoding :: PaymentSourceOwner'Address' -> Encoding

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

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

FromJSON PaymentSourceOwner'Address'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceOwner'Address'

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

mkPaymentSourceOwner'Address' :: PaymentSourceOwner'Address'

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

data PaymentSourceOwner'VerifiedAddress'

Defines the object schema located at components.schemas.payment_source.anyOf.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

PaymentSourceOwner'VerifiedAddress'

Fields

• paymentSourceOwner'VerifiedAddress'City :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• paymentSourceOwner'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
• paymentSourceOwner'VerifiedAddress'Line1 :: Maybe Text

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

  Constraints:

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

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

  Constraints:

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

  postal_code: ZIP or postal code.

  Constraints:

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

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentSourceOwner'VerifiedAddress'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceOwner'VerifiedAddress'

Defined in StripeAPI.Types.PaymentSource

Methods

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

show :: PaymentSourceOwner'VerifiedAddress' -> String

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

ToJSON PaymentSourceOwner'VerifiedAddress'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceOwner'VerifiedAddress' -> Value

toEncoding :: PaymentSourceOwner'VerifiedAddress' -> Encoding

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

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

FromJSON PaymentSourceOwner'VerifiedAddress'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceOwner'VerifiedAddress'

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

mkPaymentSourceOwner'VerifiedAddress' :: PaymentSourceOwner'VerifiedAddress'

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

data PaymentSourceRecipient'Variants

Defines the oneOf schema located at components.schemas.payment_source.anyOf.properties.recipient.anyOf in the specification.

The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

Constructors

PaymentSourceRecipient'Text Text

PaymentSourceRecipient'Recipient Recipient

Instances

Eq PaymentSourceRecipient'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

(==) :: PaymentSourceRecipient'Variants -> PaymentSourceRecipient'Variants -> Bool

(/=) :: PaymentSourceRecipient'Variants -> PaymentSourceRecipient'Variants -> Bool

Show PaymentSourceRecipient'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceRecipient'Variants -> ShowS

show :: PaymentSourceRecipient'Variants -> String

showList :: [PaymentSourceRecipient'Variants] -> ShowS

ToJSON PaymentSourceRecipient'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceRecipient'Variants -> Value

toEncoding :: PaymentSourceRecipient'Variants -> Encoding

toJSONList :: [PaymentSourceRecipient'Variants] -> Value

toEncodingList :: [PaymentSourceRecipient'Variants] -> Encoding

FromJSON PaymentSourceRecipient'Variants

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceRecipient'Variants

parseJSONList :: Value -> Parser [PaymentSourceRecipient'Variants]

data PaymentSourceSettings'

Defines the object schema located at components.schemas.payment_source.anyOf.properties.settings.anyOf in the specification.

Options for customizing how the account functions within Stripe.

Constructors

PaymentSourceSettings'

Fields

• paymentSourceSettings'BacsDebitPayments :: Maybe AccountBacsDebitPaymentsSettings

  bacs_debit_payments:

• paymentSourceSettings'Branding :: Maybe AccountBrandingSettings

  branding:

• paymentSourceSettings'CardIssuing :: Maybe AccountCardIssuingSettings

  card_issuing:

• paymentSourceSettings'CardPayments :: Maybe AccountCardPaymentsSettings

  card_payments:

• paymentSourceSettings'Dashboard :: Maybe AccountDashboardSettings

  dashboard:

• paymentSourceSettings'Payments :: Maybe AccountPaymentsSettings

  payments:

• paymentSourceSettings'Payouts :: Maybe AccountPayoutSettings

  payouts:

• paymentSourceSettings'SepaDebitPayments :: Maybe AccountSepaDebitPaymentsSettings

  sepa_debit_payments:

Instances

Eq PaymentSourceSettings'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceSettings'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceSettings' -> ShowS

show :: PaymentSourceSettings' -> String

showList :: [PaymentSourceSettings'] -> ShowS

ToJSON PaymentSourceSettings'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceSettings' -> Value

toEncoding :: PaymentSourceSettings' -> Encoding

toJSONList :: [PaymentSourceSettings'] -> Value

toEncodingList :: [PaymentSourceSettings'] -> Encoding

FromJSON PaymentSourceSettings'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceSettings'

parseJSONList :: Value -> Parser [PaymentSourceSettings']

mkPaymentSourceSettings' :: PaymentSourceSettings'

Create a new PaymentSourceSettings' with all required fields.

data PaymentSourceTransactions'

Defines the object schema located at components.schemas.payment_source.anyOf.properties.transactions in the specification.

A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key.

Constructors

PaymentSourceTransactions'

Fields

• paymentSourceTransactions'Data :: [BitcoinTransaction]

  data: Details about each object.

• paymentSourceTransactions'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• paymentSourceTransactions'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentSourceTransactions'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceTransactions'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceTransactions' -> ShowS

show :: PaymentSourceTransactions' -> String

showList :: [PaymentSourceTransactions'] -> ShowS

ToJSON PaymentSourceTransactions'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceTransactions' -> Value

toEncoding :: PaymentSourceTransactions' -> Encoding

toJSONList :: [PaymentSourceTransactions'] -> Value

toEncodingList :: [PaymentSourceTransactions'] -> Encoding

FromJSON PaymentSourceTransactions'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceTransactions'

parseJSONList :: Value -> Parser [PaymentSourceTransactions']

mkPaymentSourceTransactions'

Arguments

:: [BitcoinTransaction]

paymentSourceTransactions'Data

-> Bool

paymentSourceTransactions'HasMore

-> Text

paymentSourceTransactions'Url

-> PaymentSourceTransactions'

Create a new PaymentSourceTransactions' with all required fields.

data PaymentSourceType'

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

The Stripe account type. Can be `standard`, `express`, or `custom`.

Constructors

PaymentSourceType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentSourceType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentSourceType'EnumCustom

Represents the JSON value "custom"

PaymentSourceType'EnumExpress

Represents the JSON value "express"

PaymentSourceType'EnumStandard

Represents the JSON value "standard"

Instances

Eq PaymentSourceType'

Defined in StripeAPI.Types.PaymentSource

Methods

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

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

Show PaymentSourceType'

Defined in StripeAPI.Types.PaymentSource

Methods

showsPrec :: Int -> PaymentSourceType' -> ShowS

show :: PaymentSourceType' -> String

showList :: [PaymentSourceType'] -> ShowS

ToJSON PaymentSourceType'

Defined in StripeAPI.Types.PaymentSource

Methods

toJSON :: PaymentSourceType' -> Value

toEncoding :: PaymentSourceType' -> Encoding

toJSONList :: [PaymentSourceType'] -> Value

toEncodingList :: [PaymentSourceType'] -> Encoding

FromJSON PaymentSourceType'

Defined in StripeAPI.Types.PaymentSource

Methods

parseJSON :: Value -> Parser PaymentSourceType'

parseJSONList :: Value -> Parser [PaymentSourceType']