Mayson Monorepo Documentation
    Preparing search index...

    Interface SourceMandateNotification

    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.

    interface SourceMandateNotification {
        id: string;
        object: "source_mandate_notification";
        acss_debit?: Stripe.SourceMandateNotification.AcssDebit;
        amount: number;
        bacs_debit?: Stripe.SourceMandateNotification.BacsDebit;
        created: number;
        livemode: boolean;
        reason: string;
        sepa_debit?: Stripe.SourceMandateNotification.SepaDebit;
        source: Stripe.Source;
        status: string;
        type: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "source_mandate_notification"

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

    amount: number

    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.

    created: number

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

    livemode: boolean

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

    reason: string

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

    source: Stripe.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.

    Stripe doesn't recommend using the deprecated Sources API. We recommend that you adopt the PaymentMethods API. This newer API provides access to our latest features and payment method types.

    Related guides: Sources API and Sources & Customers.

    status: string

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

    type: string

    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.