Skip to content

get_payment_session

Operation

get_payment_session

get_payment_session(request: GetPaymentSessionInput | GetPaymentSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPaymentSessionInputDict]) -> GetPaymentSessionOutput

Get a payment session.

Parameters:

Name Type Description Default
request GetPaymentSessionInput | GetPaymentSessionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetPaymentSessionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPaymentSessionOutput

An instance of GetPaymentSessionOutput.

get_payment_session async

get_payment_session(request: GetPaymentSessionInput | GetPaymentSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPaymentSessionInputDict]) -> GetPaymentSessionOutput

Get a payment session.

Parameters:

Name Type Description Default
request GetPaymentSessionInput | GetPaymentSessionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetPaymentSessionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPaymentSessionOutput

An instance of GetPaymentSessionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetPaymentSessionInputDict

Bases: TypedDict

Dictionary form of GetPaymentSessionInput.

Attributes

agent_name instance-attribute
agent_name: str | None

The agent name associated with this request, used for observability.

payment_manager_arn instance-attribute
payment_manager_arn: Required[str]

The ARN of the payment manager that owns this session.

payment_session_id instance-attribute
payment_session_id: Required[str]

The ID of the payment session to retrieve.

user_id instance-attribute
user_id: str | None

The user ID associated with this payment session.

GetPaymentSessionInput dataclass

Bases: _SerdeShape

Request structure for getting a payment session.

Attributes

agent_name class-attribute instance-attribute
agent_name: str | None = ...

The agent name associated with this request, used for observability.

payment_manager_arn class-attribute instance-attribute
payment_manager_arn: str | None = ...

The ARN of the payment manager that owns this session.

payment_session_id class-attribute instance-attribute
payment_session_id: str | None = ...

The ID of the payment session to retrieve.

user_id class-attribute instance-attribute
user_id: str | None = ...

The user ID associated with this payment session.

Output

GetPaymentSessionOutput dataclass

Bases: _SerdeShape

Response structure for getting a payment session.

Attributes

payment_session instance-attribute
payment_session: PaymentSession

The payment session details.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.