StripeAPI.Types.ApiErrors

Contains the types generated from the schema ApiErrors

Documentation

data ApiErrors

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

Constructors

ApiErrors

Fields

• apiErrorsCharge :: Maybe Text

  charge: For card errors, the ID of the failed charge.

  Constraints:

  • Maximum length of 5000
• apiErrorsCode :: Maybe Text

  code: For some errors that could be handled programmatically, a short string indicating the error code reported.

  Constraints:

  • Maximum length of 5000
• apiErrorsDeclineCode :: Maybe Text

  decline_code: For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

  Constraints:

  • Maximum length of 5000
• apiErrorsDocUrl :: Maybe Text

  doc_url: A URL to more information about the error code reported.

  Constraints:

  • Maximum length of 5000
• apiErrorsMessage :: Maybe Text

  message: A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

  Constraints:

  • Maximum length of 40000
• apiErrorsParam :: Maybe Text

  param: If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

  Constraints:

  • Maximum length of 5000
• apiErrorsPaymentIntent :: Maybe PaymentIntent

  payment_intent: A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

  A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

  Related guide: Payment Intents API.

• apiErrorsPaymentMethod :: Maybe PaymentMethod

  payment_method: PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments.

  Related guides: Payment Methods and More Payment Scenarios.

• apiErrorsPaymentMethodType :: Maybe Text

  payment_method_type: If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

  Constraints:

  • Maximum length of 5000
• apiErrorsSetupIntent :: Maybe SetupIntent

  setup_intent: A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

  Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple statuses as it guides you through the setup process.

  Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions may need to be run through Strong Customer Authentication at the time of payment method collection in order to streamline later off-session payments. If the SetupIntent is used with a Customer, upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.

  By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time.

  Related guide: Setup Intents API.

• apiErrorsSource :: Maybe ApiErrorsSource'

  source: The source object for errors returned on a request involving a source.

• apiErrorsType :: ApiErrorsType'

  type: The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error`

Instances

Eq ApiErrors

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrors -> ApiErrors -> Bool

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

Show ApiErrors

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrors -> ShowS

show :: ApiErrors -> String

showList :: [ApiErrors] -> ShowS

ToJSON ApiErrors

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrors -> Value

toEncoding :: ApiErrors -> Encoding

toJSONList :: [ApiErrors] -> Value

toEncodingList :: [ApiErrors] -> Encoding

FromJSON ApiErrors

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrors

parseJSONList :: Value -> Parser [ApiErrors]

mkApiErrors

Arguments

:: ApiErrorsType'

apiErrorsType

-> ApiErrors

Create a new ApiErrors with all required fields.

data ApiErrorsSource'

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

The source object for errors returned on a request involving a source.

Constructors

ApiErrorsSource'

Fields

• apiErrorsSource'Account :: Maybe ApiErrorsSource'Account'Variants

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

• apiErrorsSource'AccountHolderName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'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
• apiErrorsSource'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer

  ach_credit_transfer

• apiErrorsSource'AchDebit :: Maybe SourceTypeAchDebit

  ach_debit

• apiErrorsSource'AcssDebit :: Maybe SourceTypeAcssDebit

  acss_debit

• apiErrorsSource'AddressCity :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'AddressCountry :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'AddressLine1 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'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
• apiErrorsSource'AddressLine2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'AddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'AddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'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
• apiErrorsSource'Alipay :: Maybe SourceTypeAlipay

  alipay

• apiErrorsSource'Amount :: Maybe Int

  amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.

• apiErrorsSource'AuBecsDebit :: Maybe SourceTypeAuBecsDebit

  au_becs_debit

• apiErrorsSource'AvailablePayoutMethods :: Maybe [ApiErrorsSource'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.

• apiErrorsSource'Bancontact :: Maybe SourceTypeBancontact

  bancontact

• apiErrorsSource'BankName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Brand :: Maybe Text

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

  Constraints:

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

  card

• apiErrorsSource'CardPresent :: Maybe SourceTypeCardPresent

  card_present

• apiErrorsSource'ClientSecret :: Maybe Text

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

  Constraints:

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

  code_verification:

• apiErrorsSource'Country :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Created :: Maybe Int

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

• apiErrorsSource'Currency :: Maybe Text

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

• apiErrorsSource'Customer :: Maybe ApiErrorsSource'Customer'Variants

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

• apiErrorsSource'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
• apiErrorsSource'DefaultForCurrency :: Maybe Bool

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

• apiErrorsSource'DynamicLast4 :: Maybe Text

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

  Constraints:

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

  eps

• apiErrorsSource'ExpMonth :: Maybe Int

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

• apiErrorsSource'ExpYear :: Maybe Int

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

• apiErrorsSource'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
• apiErrorsSource'Flow :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Funding :: Maybe Text

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

  Constraints:

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

  giropay

• apiErrorsSource'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

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

  ideal

• apiErrorsSource'Klarna :: Maybe SourceTypeKlarna

  klarna

• apiErrorsSource'Last4 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'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.

• apiErrorsSource'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.

• apiErrorsSource'Multibanco :: Maybe SourceTypeMultibanco

  multibanco

• apiErrorsSource'Name :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner :: Maybe ApiErrorsSource'Owner'

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

• apiErrorsSource'P24 :: Maybe SourceTypeP24

  p24

• apiErrorsSource'Receiver :: Maybe SourceReceiverFlow

  receiver:

• apiErrorsSource'Recipient :: Maybe ApiErrorsSource'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.

• apiErrorsSource'Redirect :: Maybe SourceRedirectFlow

  redirect:

• apiErrorsSource'RoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

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

  sepa_debit

• apiErrorsSource'Sofort :: Maybe SourceTypeSofort

  sofort

• apiErrorsSource'SourceOrder :: Maybe SourceOrder

  source_order:

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

  three_d_secure

• apiErrorsSource'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
• apiErrorsSource'Type :: Maybe ApiErrorsSource'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.

• apiErrorsSource'Usage :: 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
• apiErrorsSource'Wechat :: Maybe SourceTypeWechat

  wechat

Instances

Eq ApiErrorsSource'

Defined in StripeAPI.Types.ApiErrors

Methods

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

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

Show ApiErrorsSource'

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource' -> ShowS

show :: ApiErrorsSource' -> String

showList :: [ApiErrorsSource'] -> ShowS

ToJSON ApiErrorsSource'

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource' -> Value

toEncoding :: ApiErrorsSource' -> Encoding

toJSONList :: [ApiErrorsSource'] -> Value

toEncodingList :: [ApiErrorsSource'] -> Encoding

FromJSON ApiErrorsSource'

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'

parseJSONList :: Value -> Parser [ApiErrorsSource']

mkApiErrorsSource' :: ApiErrorsSource'

Create a new ApiErrorsSource' with all required fields.

data ApiErrorsSource'Account'Variants

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

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

Constructors

ApiErrorsSource'Account'Text Text

ApiErrorsSource'Account'Account Account

Instances

Eq ApiErrorsSource'Account'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrorsSource'Account'Variants -> ApiErrorsSource'Account'Variants -> Bool

(/=) :: ApiErrorsSource'Account'Variants -> ApiErrorsSource'Account'Variants -> Bool

Show ApiErrorsSource'Account'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource'Account'Variants -> ShowS

show :: ApiErrorsSource'Account'Variants -> String

showList :: [ApiErrorsSource'Account'Variants] -> ShowS

ToJSON ApiErrorsSource'Account'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource'Account'Variants -> Value

toEncoding :: ApiErrorsSource'Account'Variants -> Encoding

toJSONList :: [ApiErrorsSource'Account'Variants] -> Value

toEncodingList :: [ApiErrorsSource'Account'Variants] -> Encoding

FromJSON ApiErrorsSource'Account'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'Account'Variants

parseJSONList :: Value -> Parser [ApiErrorsSource'Account'Variants]

data ApiErrorsSource'AvailablePayoutMethods'

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

Constructors

ApiErrorsSource'AvailablePayoutMethods'Other Value

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

ApiErrorsSource'AvailablePayoutMethods'Typed Text

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

ApiErrorsSource'AvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

ApiErrorsSource'AvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq ApiErrorsSource'AvailablePayoutMethods'

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrorsSource'AvailablePayoutMethods' -> ApiErrorsSource'AvailablePayoutMethods' -> Bool

(/=) :: ApiErrorsSource'AvailablePayoutMethods' -> ApiErrorsSource'AvailablePayoutMethods' -> Bool

Show ApiErrorsSource'AvailablePayoutMethods'

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource'AvailablePayoutMethods' -> ShowS

show :: ApiErrorsSource'AvailablePayoutMethods' -> String

showList :: [ApiErrorsSource'AvailablePayoutMethods'] -> ShowS

ToJSON ApiErrorsSource'AvailablePayoutMethods'

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource'AvailablePayoutMethods' -> Value

toEncoding :: ApiErrorsSource'AvailablePayoutMethods' -> Encoding

toJSONList :: [ApiErrorsSource'AvailablePayoutMethods'] -> Value

toEncodingList :: [ApiErrorsSource'AvailablePayoutMethods'] -> Encoding

FromJSON ApiErrorsSource'AvailablePayoutMethods'

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'AvailablePayoutMethods'

parseJSONList :: Value -> Parser [ApiErrorsSource'AvailablePayoutMethods']

data ApiErrorsSource'Customer'Variants

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

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

Constructors

ApiErrorsSource'Customer'Text Text

ApiErrorsSource'Customer'Customer Customer

ApiErrorsSource'Customer'DeletedCustomer DeletedCustomer

Instances

Eq ApiErrorsSource'Customer'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrorsSource'Customer'Variants -> ApiErrorsSource'Customer'Variants -> Bool

(/=) :: ApiErrorsSource'Customer'Variants -> ApiErrorsSource'Customer'Variants -> Bool

Show ApiErrorsSource'Customer'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource'Customer'Variants -> ShowS

show :: ApiErrorsSource'Customer'Variants -> String

showList :: [ApiErrorsSource'Customer'Variants] -> ShowS

ToJSON ApiErrorsSource'Customer'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource'Customer'Variants -> Value

toEncoding :: ApiErrorsSource'Customer'Variants -> Encoding

toJSONList :: [ApiErrorsSource'Customer'Variants] -> Value

toEncodingList :: [ApiErrorsSource'Customer'Variants] -> Encoding

FromJSON ApiErrorsSource'Customer'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'Customer'Variants

parseJSONList :: Value -> Parser [ApiErrorsSource'Customer'Variants]

data ApiErrorsSource'Owner'

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

ApiErrorsSource'Owner'

Fields

• apiErrorsSource'Owner'Address :: Maybe ApiErrorsSource'Owner'Address'

  address: Owner's address.

• apiErrorsSource'Owner'Email :: Maybe Text

  email: Owner's email address.

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner'Name :: Maybe Text

  name: Owner's full name.

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner'Phone :: Maybe Text

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

  Constraints:

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

• apiErrorsSource'Owner'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
• apiErrorsSource'Owner'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
• apiErrorsSource'Owner'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 ApiErrorsSource'Owner'

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrorsSource'Owner' -> ApiErrorsSource'Owner' -> Bool

(/=) :: ApiErrorsSource'Owner' -> ApiErrorsSource'Owner' -> Bool

Show ApiErrorsSource'Owner'

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource'Owner' -> ShowS

show :: ApiErrorsSource'Owner' -> String

showList :: [ApiErrorsSource'Owner'] -> ShowS

ToJSON ApiErrorsSource'Owner'

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource'Owner' -> Value

toEncoding :: ApiErrorsSource'Owner' -> Encoding

toJSONList :: [ApiErrorsSource'Owner'] -> Value

toEncodingList :: [ApiErrorsSource'Owner'] -> Encoding

FromJSON ApiErrorsSource'Owner'

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'Owner'

parseJSONList :: Value -> Parser [ApiErrorsSource'Owner']

mkApiErrorsSource'Owner' :: ApiErrorsSource'Owner'

Create a new ApiErrorsSource'Owner' with all required fields.

data ApiErrorsSource'Owner'Address'

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

Owner\'s address.

Constructors

ApiErrorsSource'Owner'Address'

Fields

• apiErrorsSource'Owner'Address'City :: Maybe Text

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

  Constraints:

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

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner'Address'Line2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner'Address'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner'Address'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq ApiErrorsSource'Owner'Address'

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrorsSource'Owner'Address' -> ApiErrorsSource'Owner'Address' -> Bool

(/=) :: ApiErrorsSource'Owner'Address' -> ApiErrorsSource'Owner'Address' -> Bool

Show ApiErrorsSource'Owner'Address'

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource'Owner'Address' -> ShowS

show :: ApiErrorsSource'Owner'Address' -> String

showList :: [ApiErrorsSource'Owner'Address'] -> ShowS

ToJSON ApiErrorsSource'Owner'Address'

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource'Owner'Address' -> Value

toEncoding :: ApiErrorsSource'Owner'Address' -> Encoding

toJSONList :: [ApiErrorsSource'Owner'Address'] -> Value

toEncodingList :: [ApiErrorsSource'Owner'Address'] -> Encoding

FromJSON ApiErrorsSource'Owner'Address'

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'Owner'Address'

parseJSONList :: Value -> Parser [ApiErrorsSource'Owner'Address']

mkApiErrorsSource'Owner'Address' :: ApiErrorsSource'Owner'Address'

Create a new ApiErrorsSource'Owner'Address' with all required fields.

data ApiErrorsSource'Owner'VerifiedAddress'

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

ApiErrorsSource'Owner'VerifiedAddress'

Fields

• apiErrorsSource'Owner'VerifiedAddress'City :: Maybe Text

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

  Constraints:

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

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner'VerifiedAddress'Line2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner'VerifiedAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• apiErrorsSource'Owner'VerifiedAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq ApiErrorsSource'Owner'VerifiedAddress'

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrorsSource'Owner'VerifiedAddress' -> ApiErrorsSource'Owner'VerifiedAddress' -> Bool

(/=) :: ApiErrorsSource'Owner'VerifiedAddress' -> ApiErrorsSource'Owner'VerifiedAddress' -> Bool

Show ApiErrorsSource'Owner'VerifiedAddress'

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource'Owner'VerifiedAddress' -> ShowS

show :: ApiErrorsSource'Owner'VerifiedAddress' -> String

showList :: [ApiErrorsSource'Owner'VerifiedAddress'] -> ShowS

ToJSON ApiErrorsSource'Owner'VerifiedAddress'

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource'Owner'VerifiedAddress' -> Value

toEncoding :: ApiErrorsSource'Owner'VerifiedAddress' -> Encoding

toJSONList :: [ApiErrorsSource'Owner'VerifiedAddress'] -> Value

toEncodingList :: [ApiErrorsSource'Owner'VerifiedAddress'] -> Encoding

FromJSON ApiErrorsSource'Owner'VerifiedAddress'

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'Owner'VerifiedAddress'

parseJSONList :: Value -> Parser [ApiErrorsSource'Owner'VerifiedAddress']

mkApiErrorsSource'Owner'VerifiedAddress' :: ApiErrorsSource'Owner'VerifiedAddress'

Create a new ApiErrorsSource'Owner'VerifiedAddress' with all required fields.

data ApiErrorsSource'Recipient'Variants

Defines the oneOf schema located at components.schemas.api_errors.properties.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

ApiErrorsSource'Recipient'Text Text

ApiErrorsSource'Recipient'Recipient Recipient

Instances

Eq ApiErrorsSource'Recipient'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrorsSource'Recipient'Variants -> ApiErrorsSource'Recipient'Variants -> Bool

(/=) :: ApiErrorsSource'Recipient'Variants -> ApiErrorsSource'Recipient'Variants -> Bool

Show ApiErrorsSource'Recipient'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource'Recipient'Variants -> ShowS

show :: ApiErrorsSource'Recipient'Variants -> String

showList :: [ApiErrorsSource'Recipient'Variants] -> ShowS

ToJSON ApiErrorsSource'Recipient'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource'Recipient'Variants -> Value

toEncoding :: ApiErrorsSource'Recipient'Variants -> Encoding

toJSONList :: [ApiErrorsSource'Recipient'Variants] -> Value

toEncodingList :: [ApiErrorsSource'Recipient'Variants] -> Encoding

FromJSON ApiErrorsSource'Recipient'Variants

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'Recipient'Variants

parseJSONList :: Value -> Parser [ApiErrorsSource'Recipient'Variants]

data ApiErrorsSource'Type'

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

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

Constructors

ApiErrorsSource'Type'Other Value

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

ApiErrorsSource'Type'Typed Text

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

ApiErrorsSource'Type'EnumAchCreditTransfer

Represents the JSON value "ach_credit_transfer"

ApiErrorsSource'Type'EnumAchDebit

Represents the JSON value "ach_debit"

ApiErrorsSource'Type'EnumAcssDebit

Represents the JSON value "acss_debit"

ApiErrorsSource'Type'EnumAlipay

Represents the JSON value "alipay"

ApiErrorsSource'Type'EnumAuBecsDebit

Represents the JSON value "au_becs_debit"

ApiErrorsSource'Type'EnumBancontact

Represents the JSON value "bancontact"

ApiErrorsSource'Type'EnumCard

Represents the JSON value "card"

ApiErrorsSource'Type'EnumCardPresent

Represents the JSON value "card_present"

ApiErrorsSource'Type'EnumEps

Represents the JSON value "eps"

ApiErrorsSource'Type'EnumGiropay

Represents the JSON value "giropay"

ApiErrorsSource'Type'EnumIdeal

Represents the JSON value "ideal"

ApiErrorsSource'Type'EnumKlarna

Represents the JSON value "klarna"

ApiErrorsSource'Type'EnumMultibanco

Represents the JSON value "multibanco"

ApiErrorsSource'Type'EnumP24

Represents the JSON value "p24"

ApiErrorsSource'Type'EnumSepaDebit

Represents the JSON value "sepa_debit"

ApiErrorsSource'Type'EnumSofort

Represents the JSON value "sofort"

ApiErrorsSource'Type'EnumThreeDSecure

Represents the JSON value "three_d_secure"

ApiErrorsSource'Type'EnumWechat

Represents the JSON value "wechat"

Instances

Eq ApiErrorsSource'Type'

Defined in StripeAPI.Types.ApiErrors

Methods

(==) :: ApiErrorsSource'Type' -> ApiErrorsSource'Type' -> Bool

(/=) :: ApiErrorsSource'Type' -> ApiErrorsSource'Type' -> Bool

Show ApiErrorsSource'Type'

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsSource'Type' -> ShowS

show :: ApiErrorsSource'Type' -> String

showList :: [ApiErrorsSource'Type'] -> ShowS

ToJSON ApiErrorsSource'Type'

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsSource'Type' -> Value

toEncoding :: ApiErrorsSource'Type' -> Encoding

toJSONList :: [ApiErrorsSource'Type'] -> Value

toEncodingList :: [ApiErrorsSource'Type'] -> Encoding

FromJSON ApiErrorsSource'Type'

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsSource'Type'

parseJSONList :: Value -> Parser [ApiErrorsSource'Type']

data ApiErrorsType'

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

The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error`

Constructors

ApiErrorsType'Other Value

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

ApiErrorsType'Typed Text

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

ApiErrorsType'EnumApiConnectionError

Represents the JSON value "api_connection_error"

ApiErrorsType'EnumApiError

Represents the JSON value "api_error"

ApiErrorsType'EnumAuthenticationError

Represents the JSON value "authentication_error"

ApiErrorsType'EnumCardError

Represents the JSON value "card_error"

ApiErrorsType'EnumIdempotencyError

Represents the JSON value "idempotency_error"

ApiErrorsType'EnumInvalidRequestError

Represents the JSON value "invalid_request_error"

ApiErrorsType'EnumRateLimitError

Represents the JSON value "rate_limit_error"

Instances

Eq ApiErrorsType'

Defined in StripeAPI.Types.ApiErrors

Methods

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

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

Show ApiErrorsType'

Defined in StripeAPI.Types.ApiErrors

Methods

showsPrec :: Int -> ApiErrorsType' -> ShowS

show :: ApiErrorsType' -> String

showList :: [ApiErrorsType'] -> ShowS

ToJSON ApiErrorsType'

Defined in StripeAPI.Types.ApiErrors

Methods

toJSON :: ApiErrorsType' -> Value

toEncoding :: ApiErrorsType' -> Encoding

toJSONList :: [ApiErrorsType'] -> Value

toEncodingList :: [ApiErrorsType'] -> Encoding

FromJSON ApiErrorsType'

Defined in StripeAPI.Types.ApiErrors

Methods

parseJSON :: Value -> Parser ApiErrorsType'

parseJSONList :: Value -> Parser [ApiErrorsType']