Stripe: Retrieve a Mandate

← Mandates operations · Get started

Operation stripe.getmandatesmandate

Provider route: GET /v1/mandates/{mandate}. 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["mandates"]["getMandatesMandate"]>[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.mandates.getMandatesMandate(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.mandates.get_mandates_mandate(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	string	Required within parent
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 Mandate — response body

Referenced models: Retrieve a Mandate — response body

Schemas

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

Retrieve a Mandate — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Mandate is a record of the permission that your customer gives you to debit their payment method.
customer_acceptance	Model	Required within parent	Expand Retrieve a Mandate — response body — customer acceptance
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`.
multi_use	Model	Optional	Expand Retrieve a Mandate — response body — multi use
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: mandate
on_behalf_of	string	Optional	The account (if any) that the mandate is intended for. Maximum length: 5000
payment_method	JSON	Required within parent	ID of the payment method associated with this mandate.
payment_method (anyOf 1)	string	Alternative	Maximum length: 5000
payment_method (anyOf 2)	Model	Alternative	Expand Create a Payment Method — response body
payment_method_details	Model	Required within parent	Expand Retrieve a Mandate — response body — payment method details
single_use	Model	Optional	Expand Retrieve a Mandate — response body — single use
status	string	Required within parent	The mandate status indicates whether or not you can use it to initiate a payment. Known values: active, inactive, pending
type	string	Required within parent	The type of the mandate. Known values: multi_use, single_use

Referenced models: Retrieve a Mandate — response body — customer acceptance, Retrieve a Mandate — response body — multi use, Retrieve a Mandate — response body — payment method details, Retrieve a Mandate — response body — single use, Create a Payment Method — response body

Retrieve a Mandate — response body — customer acceptance

Field	Type	Presence	Description and constraints
$	object	Root
accepted_at	JSON	Optional
accepted_at (anyOf 1)	JSON	Alternative
accepted_at (anyOf 1) (anyOf 1)	integer	Alternative	The time that the customer accepts the mandate. Format: unix-time
accepted_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
accepted_at (anyOf 2)	null	Alternative
offline	Model	Optional	Expand Create a Payment Method — response body — zip
online	Model	Optional	Expand Retrieve a Mandate — response body — customer acceptance online
type	string	Required within parent	The mandate includes the type of customer acceptance information, such as: `online` or `offline`. Known values: offline, online

Referenced models: Create a Payment Method — response body — zip, Retrieve a Mandate — response body — customer acceptance online

Retrieve a Mandate — response body — multi use

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Optional
amount (anyOf 1)	integer	Alternative	The amount of the payment on a multi use mandate.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Optional	The currency of the payment on a multi use mandate. Format: currency

Retrieve a Mandate — response body — payment method details

Field	Type	Presence	Description and constraints
$	object	Root
acss_debit	Model	Optional	Expand Retrieve a Mandate — response body — payment method details acss debit
amazon_pay	Model	Optional	Expand Create a Payment Method — response body — zip
au_becs_debit	Model	Optional	Expand Retrieve a Mandate — response body — payment method details au becs debit
bacs_debit	Model	Optional	Expand Retrieve a Mandate — response body — payment method details bacs debit
blik	Model	Optional	Expand Retrieve a Mandate — response body — payment method details blik
card	Model	Optional	Expand Retrieve a Mandate — response body — payment method details card
cashapp	Model	Optional	Expand Create a Payment Method — response body — zip
kakao_pay	Model	Optional	Expand Create a Payment Method — response body — zip
klarna	Model	Optional	Expand Create a Payment Method — response body — zip
kr_card	Model	Optional	Expand Create a Payment Method — response body — zip
link	Model	Optional	Expand Create a Payment Method — response body — zip
naver_pay	Model	Optional	Expand Create a Payment Method — response body — zip
nz_bank_account	Model	Optional	Expand Create a Payment Method — response body — zip
paypal	Model	Optional	Expand Retrieve a Mandate — response body — payment method details paypal
payto	Model	Optional	Expand Retrieve a Mandate — response body — payment method details payto
pix	Model	Optional	Expand Retrieve a Mandate — response body — payment method details pix
revolut_pay	Model	Optional	Expand Create a Payment Method — response body — zip
sepa_debit	Model	Optional	Expand Retrieve a Mandate — response body — payment method details sepa debit
twint	Model	Optional	Expand Create a Payment Method — response body — zip
type	string	Required within parent	This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method. Maximum length: 5000
upi	Model	Optional	Expand Retrieve a Mandate — response body — payment method details upi
us_bank_account	Model	Optional	Expand Retrieve a Mandate — response body — payment method details us bank account

Referenced models: Create a Payment Method — response body — zip, Retrieve a Mandate — response body — payment method details card, Retrieve a Mandate — response body — payment method details upi, Retrieve a Mandate — response body — payment method details acss debit, Retrieve a Mandate — response body — payment method details au becs debit, Retrieve a Mandate — response body — payment method details bacs debit, Retrieve a Mandate — response body — payment method details blik, Retrieve a Mandate — response body — payment method details paypal, Retrieve a Mandate — response body — payment method details payto, Retrieve a Mandate — response body — payment method details pix, Retrieve a Mandate — response body — payment method details sepa debit, Retrieve a Mandate — response body — payment method details us bank account

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
$	object	Root

Policy, approvals and errors

SDK function policy ID: stripe.getmandatesmandate. Catalog operation: GetMandatesMandate. 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