Sample - Stripe API
GET/v1/sources/{source}/mandate_notifications/{mandate_notification}

Retrieve a source mandate notification

Retrieves a mandate notification associated with a source. Provide both the parent source identifier and the mandate_notification identifier to retrieve the notification's status, reason, amount, and payment-method details. Use expand when you need additional response fields.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
mandate_notificationstringrequired
The unique identifier of the mandate notification to retrieve, limited to 5,000 characters.
sourcestringrequired
The unique identifier of the source associated with the mandate notification, limited to 5,000 characters.
expandarray<string>optional
Fields to expand in the response; each value may contain at most 5,000 characters.

2 status codes
200Returns the source mandate notification, including its identifier, reason, status, source, amount, type, and creation time.
acss_debitobjectoptional
amountintegeroptional
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`.
bacs_debitobjectoptional
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:source_mandate_notification
reasonstringrequired
The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.
sepa_debitobjectoptional
sourceobjectrequired
`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](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
statusstringrequired
The status of the mandate notification. Valid statuses are `pending` or `submitted`.
typestringrequired
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`.
defaultReturns an error object containing details about the failed mandate notification retrieval request.
errorobjectrequired

Error handling

source and mandate_notification must identify the related source and mandate notification, and each may contain at most 5,000 characters. expand values may contain at most 5,000 characters each.