Defines the object schema located at components.schemas.payment_source.anyOf in the specification.
Constructors
PaymentSourcepaymentSourceAccount :: Maybe (Nullable PaymentSourceAccount'NonNullableVariants)account: The ID of the account that the bank account is associated with.
paymentSourceAccountHolderName :: Maybe (Nullable Text)account_holder_name: The name of the person or business that owns the bank account.
Constraints:
Maximum length of 5000
paymentSourceAccountHolderType :: Maybe (Nullable Text)account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.
Constraints:
Maximum length of 5000
paymentSourceAccountType :: Maybe (Nullable Text)account_type: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
Constraints:
Maximum length of 5000
paymentSourceAchCreditTransfer :: Maybe SourceTypeAchCreditTransferach_credit_transfer
paymentSourceAchDebit :: Maybe SourceTypeAchDebitach_debit
paymentSourceAcssDebit :: Maybe SourceTypeAcssDebitacss_debit
paymentSourceActive :: Maybe Boolactive: True when this bitcoin receiver has received a non-zero amount of bitcoin.
paymentSourceAddressCity :: Maybe (Nullable Text)address_city: City/District/Suburb/Town/Village.
Constraints:
Maximum length of 5000
paymentSourceAddressCountry :: Maybe (Nullable Text)address_country: Billing address country, if provided when creating card.
Constraints:
Maximum length of 5000
paymentSourceAddressLine1 :: Maybe (Nullable Text)address_line1: Address line 1 (Street address/PO Box/Company name).
Constraints:
Maximum length of 5000
paymentSourceAddressLine1Check :: Maybe (Nullable 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 (Nullable Text)address_line2: Address line 2 (Apartment/Suite/Unit/Building).
Constraints:
Maximum length of 5000
paymentSourceAddressState :: Maybe (Nullable Text)address_state: State/County/Province/Region.
Constraints:
Maximum length of 5000
paymentSourceAddressZip :: Maybe (Nullable Text)address_zip: ZIP or postal code.
Constraints:
Maximum length of 5000
paymentSourceAddressZipCheck :: Maybe (Nullable 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 SourceTypeAlipayalipay
paymentSourceAmount :: Maybe Intamount: The amount of `currency` that you are collecting as payment.
paymentSourceAmountReceived :: Maybe Intamount_received: The amount of `currency` to which `bitcoin_amount_received` has been converted.
paymentSourceAuBecsDebit :: Maybe SourceTypeAuBecsDebitau_becs_debit
paymentSourceAvailablePayoutMethods :: Maybe (Nullable [PaymentSourceAvailablePayoutMethods'NonNullable])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 SourceTypeBancontactbancontact
paymentSourceBankName :: Maybe (Nullable Text)bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
Constraints:
Maximum length of 5000
paymentSourceBitcoinAmount :: Maybe Intbitcoin_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 Intbitcoin_amount_received: The amount of bitcoin that has been sent by the customer to this receiver.
paymentSourceBitcoinUri :: Maybe Textbitcoin_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 Textbrand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
Constraints:
Maximum length of 5000
paymentSourceBusinessProfile :: Maybe (Nullable PaymentSourceBusinessProfile'NonNullable)business_profile: Business information about the account.
paymentSourceBusinessType :: Maybe (Nullable PaymentSourceBusinessType'NonNullable)business_type: The business type.
paymentSourceCapabilities :: Maybe AccountCapabilitiescapabilities:
paymentSourceCard :: Maybe SourceTypeCardcard
paymentSourceCardPresent :: Maybe SourceTypeCardPresentcard_present
paymentSourceChargesEnabled :: Maybe Boolcharges_enabled: Whether the account can create live charges.
paymentSourceClientSecret :: Maybe Textclient_secret: The client secret of the source. Used for client-side retrieval using a publishable key.
Constraints:
Maximum length of 5000
paymentSourceCodeVerification :: Maybe SourceCodeVerificationFlowcode_verification:
paymentSourceCompany :: Maybe LegalEntityCompanycompany:
paymentSourceController :: Maybe AccountUnificationAccountControllercontroller:
paymentSourceCountry :: Maybe Textcountry: The account's country.
Constraints:
Maximum length of 5000
paymentSourceCreated :: Maybe Intcreated: Time at which the account was connected. Measured in seconds since the Unix epoch.
paymentSourceCurrency :: Maybe Textcurrency: Three-letter ISO code for the currency paid out to the bank account.
paymentSourceCustomer :: Maybe (Nullable PaymentSourceCustomer'NonNullableVariants)customer: The ID of the customer associated with this Alipay Account.
paymentSourceCvcCheck :: Maybe (Nullable 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 Textdefault_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 (Nullable Bool)default_for_currency: Whether this bank account is the default external account for its currency.
paymentSourceDescription :: Maybe (Nullable Text)description: An arbitrary string attached to the object. Often useful for displaying to users.
Constraints:
Maximum length of 5000
paymentSourceDetailsSubmitted :: Maybe Booldetails_submitted: Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.
paymentSourceDynamicLast4 :: Maybe (Nullable Text)dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.
Constraints:
Maximum length of 5000
paymentSourceEmail :: Maybe (Nullable 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 SourceTypeEpseps
paymentSourceExpMonth :: Maybe Intexp_month: Two-digit number representing the card's expiration month.
paymentSourceExpYear :: Maybe Intexp_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 Boolfilled: This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver.
paymentSourceFingerprint :: Maybe Textfingerprint: 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 Textflow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.
Constraints:
Maximum length of 5000
paymentSourceFunding :: Maybe Textfunding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
Constraints:
Maximum length of 5000
paymentSourceFutureRequirements :: Maybe AccountFutureRequirementsfuture_requirements:
paymentSourceGiropay :: Maybe SourceTypeGiropaygiropay
paymentSourceId :: Maybe Textid: Unique identifier for the object.
Constraints:
Maximum length of 5000
paymentSourceIdeal :: Maybe SourceTypeIdealideal
paymentSourceInboundAddress :: Maybe Textinbound_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 Personindividual: 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 SourceTypeKlarnaklarna
paymentSourceLast4 :: Maybe Textlast4: The last four digits of the bank account number.
Constraints:
Maximum length of 5000
paymentSourceLivemode :: Maybe Boollivemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
paymentSourceMetadata :: Maybe Objectmetadata: 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 SourceTypeMultibancomultibanco
paymentSourceName :: Maybe (Nullable 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 (Nullable PaymentSourceOwner'NonNullable)owner: Information about the owner of the payment instrument that may be used or required by particular source types.
paymentSourceP24 :: Maybe SourceTypeP24p24
paymentSourcePayment :: Maybe (Nullable 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 (Nullable Int)payment_amount: If the Alipay account object is not reusable, the exact amount that you can create a charge for.
paymentSourcePaymentCurrency :: Maybe (Nullable Text)payment_currency: If the Alipay account object is not reusable, the exact currency that you can create a charge for.
paymentSourcePayoutsEnabled :: Maybe Boolpayouts_enabled: Whether Stripe can send payouts to this account.
paymentSourceReceiver :: Maybe SourceReceiverFlowreceiver:
paymentSourceRecipient :: Maybe (Nullable PaymentSourceRecipient'NonNullableVariants)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 SourceRedirectFlowredirect:
paymentSourceRefundAddress :: Maybe (Nullable Text)refund_address: The refund address of this bitcoin receiver.
Constraints:
Maximum length of 5000
paymentSourceRequirements :: Maybe AccountRequirementsrequirements:
paymentSourceReusable :: Maybe Boolreusable: 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 (Nullable Text)routing_number: The routing transit number for the bank account.
Constraints:
Maximum length of 5000
paymentSourceSepaDebit :: Maybe SourceTypeSepaDebitsepa_debit
paymentSourceSettings :: Maybe (Nullable PaymentSourceSettings'NonNullable)settings: Options for customizing how the account functions within Stripe.
paymentSourceSofort :: Maybe SourceTypeSofortsofort
paymentSourceSourceOrder :: Maybe SourceOrdersource_order:
paymentSourceStatementDescriptor :: 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
paymentSourceStatus :: Maybe Textstatus: 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 SourceTypeThreeDSecurethree_d_secure
paymentSourceTokenizationMethod :: Maybe (Nullable 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 AccountTosAcceptancetos_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 Booluncaptured_funds: This receiver contains uncaptured funds that can be used for a payment or refunded.
paymentSourceUsage :: 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
paymentSourceUsed :: Maybe Boolused: Whether this Alipay account object has ever been used for a payment.
paymentSourceUsedForPayment :: Maybe (Nullable Bool)used_for_payment: Indicate if this source is used for payment.
paymentSourceUsername :: Maybe Textusername: The username for the Alipay account.
Constraints:
Maximum length of 5000
paymentSourceWechat :: Maybe SourceTypeWechatwechat
Instances4Eq, Show, FromJSON, ToJSON
Eq PaymentSourceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PaymentSourceShow PaymentSourceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PaymentSourceFromJSON PaymentSourceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PaymentSourceToJSON PaymentSourceDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PaymentSource