StripeAPI.Types.SourceMandateNotification

Contains the types generated from the schema SourceMandateNotification

Documentation

data SourceMandateNotification

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

Source mandate notifications should be created when a notification related to a source mandate must be sent to the payer. They will trigger a webhook or deliver an email to the customer.

Constructors

SourceMandateNotification

Fields

• sourceMandateNotificationAcssDebit :: Maybe SourceMandateNotificationAcssDebitData

  acss_debit:

• sourceMandateNotificationAmount :: 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 amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`.

• sourceMandateNotificationBacsDebit :: Maybe SourceMandateNotificationBacsDebitData

  bacs_debit:

• sourceMandateNotificationCreated :: Int

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

• sourceMandateNotificationId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• sourceMandateNotificationLivemode :: Bool

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

• sourceMandateNotificationReason :: Text

  reason: The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.

  Constraints:

  • Maximum length of 5000
• sourceMandateNotificationSepaDebit :: Maybe SourceMandateNotificationSepaDebitData

  sepa_debit:

• sourceMandateNotificationSource :: Source

  source: `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers.

  Related guides: Sources API and Sources & Customers.

• sourceMandateNotificationStatus :: Text

  status: The status of the mandate notification. Valid statuses are `pending` or `submitted`.

  Constraints:

  • Maximum length of 5000
• sourceMandateNotificationType :: Text

  type: The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`.

  Constraints:

  • Maximum length of 5000

Instances

Eq SourceMandateNotification

Defined in StripeAPI.Types.SourceMandateNotification

Methods

(==) :: SourceMandateNotification -> SourceMandateNotification -> Bool

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

Show SourceMandateNotification

Defined in StripeAPI.Types.SourceMandateNotification

Methods

showsPrec :: Int -> SourceMandateNotification -> ShowS

show :: SourceMandateNotification -> String

showList :: [SourceMandateNotification] -> ShowS

ToJSON SourceMandateNotification

Defined in StripeAPI.Types.SourceMandateNotification

Methods

toJSON :: SourceMandateNotification -> Value

toEncoding :: SourceMandateNotification -> Encoding

toJSONList :: [SourceMandateNotification] -> Value

toEncodingList :: [SourceMandateNotification] -> Encoding

FromJSON SourceMandateNotification

Defined in StripeAPI.Types.SourceMandateNotification

Methods

parseJSON :: Value -> Parser SourceMandateNotification

parseJSONList :: Value -> Parser [SourceMandateNotification]

mkSourceMandateNotification

Arguments

:: Int

sourceMandateNotificationCreated

-> Text

sourceMandateNotificationId

-> Bool

sourceMandateNotificationLivemode

-> Text

sourceMandateNotificationReason

-> Source

sourceMandateNotificationSource

-> Text

sourceMandateNotificationStatus

-> Text

sourceMandateNotificationType

-> SourceMandateNotification

Create a new SourceMandateNotification with all required fields.