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

Source

object

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

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 total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.

client_secret string
required

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

created integer (unix-time)
required

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

currency string
optionalnullable

Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.

customer string
optional

The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.

flow string
required

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

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.

metadata object
optionalnullable

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

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

owner
optionalnullable

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

statement_descriptor string
optionalnullable

Extra information about a source. This will appear on your customer's statement every time you charge the source.

status string
required

The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.

type string
required

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](https://stripe.com/docs/sources) used.

usage string
optionalnullable

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.