Documentation

Fields

• getCustomersCustomerSourcesResponseBody200Data :: [] GetCustomersCustomerSourcesResponseBody200Data'

  data: Details about each object.

• getCustomersCustomerSourcesResponseBody200HasMore :: Bool

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

• getCustomersCustomerSourcesResponseBody200Object :: GetCustomersCustomerSourcesResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getCustomersCustomerSourcesResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Fields

• getCustomersCustomerSourcesResponseBody200Data'Account :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Account'Variants

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

• getCustomersCustomerSourcesResponseBody200Data'AccountHolderName :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AccountHolderType :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer

  ach_credit_transfer

• getCustomersCustomerSourcesResponseBody200Data'AchDebit :: Maybe SourceTypeAchDebit

  ach_debit

• getCustomersCustomerSourcesResponseBody200Data'Active :: Maybe Bool

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

• getCustomersCustomerSourcesResponseBody200Data'AddressCity :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AddressCountry :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AddressLine1 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AddressLine1Check :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AddressLine2 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AddressState :: Maybe String

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AddressZip :: Maybe String

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'AddressZipCheck :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Alipay :: Maybe SourceTypeAlipay

  alipay

• getCustomersCustomerSourcesResponseBody200Data'Amount :: Maybe Integer

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

• getCustomersCustomerSourcesResponseBody200Data'AmountReceived :: Maybe Integer

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

• getCustomersCustomerSourcesResponseBody200Data'AvailablePayoutMethods :: Maybe ([] GetCustomersCustomerSourcesResponseBody200Data'AvailablePayoutMethods')

  available_payout_methods: A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.

• getCustomersCustomerSourcesResponseBody200Data'Bancontact :: Maybe SourceTypeBancontact

  bancontact

• getCustomersCustomerSourcesResponseBody200Data'BankName :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'BitcoinAmount :: Maybe Integer

  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.

• getCustomersCustomerSourcesResponseBody200Data'BitcoinAmountReceived :: Maybe Integer

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

• getCustomersCustomerSourcesResponseBody200Data'BitcoinUri :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Brand :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Card :: Maybe SourceTypeCard

  card

• getCustomersCustomerSourcesResponseBody200Data'CardPresent :: Maybe SourceTypeCardPresent

  card_present

• getCustomersCustomerSourcesResponseBody200Data'ClientSecret :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'CodeVerification :: Maybe SourceCodeVerificationFlow

  code_verification:

• getCustomersCustomerSourcesResponseBody200Data'Country :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Created :: Maybe Integer

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

• getCustomersCustomerSourcesResponseBody200Data'Currency :: Maybe String

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

• getCustomersCustomerSourcesResponseBody200Data'Customer :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Customer'Variants

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

• getCustomersCustomerSourcesResponseBody200Data'CvcCheck :: Maybe String

  cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'DefaultForCurrency :: Maybe Bool

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

• getCustomersCustomerSourcesResponseBody200Data'Description :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'DynamicLast4 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Email :: Maybe String

  email: The customer's email address, set by the API call that creates the receiver.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Eps :: Maybe SourceTypeEps

  eps

• getCustomersCustomerSourcesResponseBody200Data'ExpMonth :: Maybe Integer

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

• getCustomersCustomerSourcesResponseBody200Data'ExpYear :: Maybe Integer

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

• getCustomersCustomerSourcesResponseBody200Data'Filled :: Maybe Bool

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

• getCustomersCustomerSourcesResponseBody200Data'Fingerprint :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Flow :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Funding :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Giropay :: Maybe SourceTypeGiropay

  giropay

• getCustomersCustomerSourcesResponseBody200Data'Id :: Maybe String

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Ideal :: Maybe SourceTypeIdeal

  ideal

• getCustomersCustomerSourcesResponseBody200Data'InboundAddress :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Klarna :: Maybe SourceTypeKlarna

  klarna

• getCustomersCustomerSourcesResponseBody200Data'Last4 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Livemode :: 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.

• getCustomersCustomerSourcesResponseBody200Data'Metadata :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Metadata'

  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.

• getCustomersCustomerSourcesResponseBody200Data'Multibanco :: Maybe SourceTypeMultibanco

  multibanco

• getCustomersCustomerSourcesResponseBody200Data'Name :: Maybe String

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Object :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Object'

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

• getCustomersCustomerSourcesResponseBody200Data'Owner :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Owner'

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

• getCustomersCustomerSourcesResponseBody200Data'P24 :: Maybe SourceTypeP24

  p24

• getCustomersCustomerSourcesResponseBody200Data'Payment :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'PaymentAmount :: Maybe Integer

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

• getCustomersCustomerSourcesResponseBody200Data'PaymentCurrency :: Maybe String

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

• getCustomersCustomerSourcesResponseBody200Data'Receiver :: Maybe SourceReceiverFlow

  receiver:

• getCustomersCustomerSourcesResponseBody200Data'Recipient :: Maybe GetCustomersCustomerSourcesResponseBody200Data'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.

• getCustomersCustomerSourcesResponseBody200Data'Redirect :: Maybe SourceRedirectFlow

  redirect:

• getCustomersCustomerSourcesResponseBody200Data'RefundAddress :: Maybe String

  refund_address: The refund address of this bitcoin receiver.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Reusable :: 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.

• getCustomersCustomerSourcesResponseBody200Data'RoutingNumber :: Maybe String

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'SepaDebit :: Maybe SourceTypeSepaDebit

  sepa_debit

• getCustomersCustomerSourcesResponseBody200Data'Sofort :: Maybe SourceTypeSofort

  sofort

• getCustomersCustomerSourcesResponseBody200Data'SourceOrder :: Maybe SourceOrder

  source_order:

• getCustomersCustomerSourcesResponseBody200Data'StatementDescriptor :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Status :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'ThreeDSecure :: Maybe SourceTypeThreeDSecure

  three_d_secure

• getCustomersCustomerSourcesResponseBody200Data'TokenizationMethod :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Transactions :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Transactions'

  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.

• getCustomersCustomerSourcesResponseBody200Data'Type :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Type'

  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.

• getCustomersCustomerSourcesResponseBody200Data'UncapturedFunds :: Maybe Bool

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

• getCustomersCustomerSourcesResponseBody200Data'Usage :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Used :: Maybe Bool

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

• getCustomersCustomerSourcesResponseBody200Data'UsedForPayment :: Maybe Bool

  used_for_payment: Indicate if this source is used for payment.

• getCustomersCustomerSourcesResponseBody200Data'Username :: Maybe String

  username: The username for the Alipay account.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Wechat :: Maybe SourceTypeWechat

  wechat

Fields

• getCustomersCustomerSourcesResponseBody200Data'Owner'Address :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Owner'Address'

  address: Owner's address.

• getCustomersCustomerSourcesResponseBody200Data'Owner'Email :: Maybe String

  email: Owner's email address.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'Name :: Maybe String

  name: Owner's full name.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'Phone :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedAddress :: Maybe GetCustomersCustomerSourcesResponseBody200Data'Owner'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.

• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedEmail :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedName :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedPhone :: Maybe String

  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

Fields

• getCustomersCustomerSourcesResponseBody200Data'Owner'Address'City :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'Address'Country :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Owner'Address'Line1 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'Address'Line2 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'Address'PostalCode :: Maybe String

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'Address'State :: Maybe String

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Fields

• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedAddress'City :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedAddress'Country :: Maybe String

  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
• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedAddress'Line1 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedAddress'Line2 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedAddress'PostalCode :: Maybe String

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSourcesResponseBody200Data'Owner'VerifiedAddress'State :: Maybe String

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Fields

• getCustomersCustomerSourcesResponseBody200Data'Transactions'Data :: [] BitcoinTransaction

  data: Details about each object.

• getCustomersCustomerSourcesResponseBody200Data'Transactions'HasMore :: Bool

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

• getCustomersCustomerSourcesResponseBody200Data'Transactions'Object :: GetCustomersCustomerSourcesResponseBody200Data'Transactions'Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getCustomersCustomerSourcesResponseBody200Data'Transactions'Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000