Skip to main content
Schema2020-08-27object

source_mandate_notification

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.

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

SourceMandateNotification

object

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.

amount integer
optionalnullable

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 integer (unix-time)
required

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

id string
required

Unique identifier for the object.

livemode boolean
required

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

object string
required

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

reason string
required

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

source Source object
required

`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](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).

status string
required

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

type string
required

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`.