Stripe: Retrieve a Source Mandate Notification

Stripe sources.getSourcesSourceMandateNotificationsMandateNotification: arguments, response, policy and SDK examples.

Operation stripe.getsourcessourcemandatenotificationsmandatenotification

Provider route: GET /v1/sources/{source}/mandate_notifications/{mandate_notification}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["sources"]["getSourcesSourceMandateNotificationsMandateNotification"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.sources.getSourcesSourceMandateNotificationsMandateNotification(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.sources.get_sources_source_mandate_notifications_mandate_notification(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.mandate_notification`	string	Required within parent	Maximum length: 5000
`path.source`	string	Required within parent	Maximum length: 5000
`query`	object	Optional	Additional keys: not allowed
`query.expand`	array	Optional
`query.expand[]`	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Retrieve a Source Mandate Notification — response body

Referenced models: Retrieve a Source Mandate Notification — response body

Schemas

23 more schemas are linked from the tables above, on the schema pages.

Retrieve a Source Mandate Notification — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	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.
`acss_debit`	Model	Optional	Expand Retrieve a Source Mandate Notification — response body — acss debit
`amount`	JSON	Optional
`amount (anyOf 1)`	JSON	Alternative
`amount (anyOf 1) (anyOf 1)`	integer	Alternative	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`.
`amount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`amount (anyOf 2)`	null	Alternative
`bacs_debit`	Model	Optional	Expand Retrieve a Source Mandate Notification — response body — bacs debit
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: source_mandate_notification
`reason`	string	Required within parent	The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. Maximum length: 5000
`sepa_debit`	Model	Optional	Expand Retrieve a Source Mandate Notification — response body — sepa debit
`source`	Model	Required within parent	Expand Create a source — response body
`status`	string	Required within parent	The status of the mandate notification. Valid statuses are `pending` or `submitted`. Maximum length: 5000
`type`	string	Required within parent	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`. Maximum length: 5000

Referenced models: Create a source — response body, Retrieve a Source Mandate Notification — response body — acss debit, Retrieve a Source Mandate Notification — response body — bacs debit, Retrieve a Source Mandate Notification — response body — sepa debit

Retrieve a Source Mandate Notification — response body — acss debit

Field	Type	Presence	Description and constraints
`$`	object	Root
`statement_descriptor`	string	Optional	The statement descriptor associate with the debit. Maximum length: 5000

Retrieve a Source Mandate Notification — response body — bacs debit

Field	Type	Presence	Description and constraints
`$`	object	Root
`last4`	string	Optional	Last 4 digits of the account number associated with the debit. Maximum length: 5000

Retrieve a Source Mandate Notification — response body — sepa debit

Field	Type	Presence	Description and constraints
`$`	object	Root
`creditor_identifier`	string	Optional	SEPA creditor ID. Maximum length: 5000
`last4`	string	Optional	Last 4 digits of the account number associated with the debit. Maximum length: 5000
`mandate_reference`	string	Optional	Mandate reference associated with the debit. Maximum length: 5000

Create a source — response body — code verification

Field	Type	Presence	Description and constraints
`$`	object	Root
`attempts_remaining`	JSON	Required within parent
`attempts_remaining (anyOf 1)`	integer	Alternative	The number of attempts remaining to authenticate the source object with a verification code.
`attempts_remaining (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`status`	string	Required within parent	The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). Maximum length: 5000

Create a source — response body — source order

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount`	JSON	Required within parent
`amount (anyOf 1)`	integer	Alternative	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 for the order.
`amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`currency`	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency
`email`	string	Optional	The email address of the customer placing the order. Maximum length: 5000
`items`	JSON	Optional
`items (anyOf 1)`	array	Alternative	List of items constituting the order.
`items (anyOf 1)[]`	Model	Each item	Expand Create a source — response body — source order items List of items constituting the order item
`items (anyOf 2)`	null	Alternative
`shipping`	Model	Optional	Expand Create a source — response body — source order shipping

Referenced models: Create a source — response body — source order shipping, Create a source — response body — source order items List of items constituting the order item

Create a source — response body — owner value address, email, name, phone, verified address, verified email, verified name, verified phone

Field	Type	Presence	Description and constraints
`$`	object	Root
`address`	JSON	Optional
`address (anyOf 1)`	JSON	Alternative	Owner's address.
`address (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Location — response body — address
`address (anyOf 2)`	null	Alternative
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative	Owner's email address. Maximum length: 5000
`email (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	Owner's full name. Maximum length: 5000
`name (anyOf 2)`	null	Alternative
`phone`	JSON	Optional
`phone (anyOf 1)`	string	Alternative	Owner's phone number (including extension). Maximum length: 5000
`phone (anyOf 2)`	null	Alternative
`verified_address`	JSON	Optional
`verified_address (anyOf 1)`	JSON	Alternative	Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
`verified_address (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Location — response body — address
`verified_address (anyOf 2)`	null	Alternative
`verified_email`	JSON	Optional
`verified_email (anyOf 1)`	string	Alternative	Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000
`verified_email (anyOf 2)`	null	Alternative
`verified_name`	JSON	Optional
`verified_name (anyOf 1)`	string	Alternative	Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000
`verified_name (anyOf 2)`	null	Alternative
`verified_phone`	JSON	Optional
`verified_phone (anyOf 1)`	string	Alternative	Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000
`verified_phone (anyOf 2)`	null	Alternative

Referenced models: Create a Location — response body — address

Create a source — response body — p24

Field	Type	Presence
`$`	object	Root
`reference`	JSON	Optional
`reference (anyOf 1)`	string	Alternative
`reference (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: stripe.getsourcessourcemandatenotificationsmandatenotification. Catalog operation: GetSourcesSourceMandateNotificationsMandateNotification. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page