Skip to content

delete_payment_session

Operation

delete_payment_session

delete_payment_session(request: DeletePaymentSessionInput | DeletePaymentSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePaymentSessionInputDict]) -> DeletePaymentSessionOutput

Deletes a payment session. This permanently removes the payment session record.

Parameters:

Name Type Description Default
request DeletePaymentSessionInput | DeletePaymentSessionInputDict | 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[DeletePaymentSessionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeletePaymentSessionOutput

An instance of DeletePaymentSessionOutput.

delete_payment_session async

delete_payment_session(request: DeletePaymentSessionInput | DeletePaymentSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePaymentSessionInputDict]) -> DeletePaymentSessionOutput

Deletes a payment session. This permanently removes the payment session record.

Parameters:

Name Type Description Default
request DeletePaymentSessionInput | DeletePaymentSessionInputDict | 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[DeletePaymentSessionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeletePaymentSessionOutput

An instance of DeletePaymentSessionOutput.

Input

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

DeletePaymentSessionInputDict

Bases: TypedDict

Dictionary form of DeletePaymentSessionInput.

Attributes

payment_manager_arn instance-attribute
payment_manager_arn: Required[str]

The payment manager ARN. Must match the session's paymentManagerArn.

payment_session_id instance-attribute
payment_session_id: Required[str]

The payment session ID to delete.

user_id instance-attribute
user_id: str | None

The user ID making the delete request. Must match the session's userId.

DeletePaymentSessionInput dataclass

Bases: _SerdeShape

Request structure for deleting a payment session.

Attributes

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

The payment manager ARN. Must match the session's paymentManagerArn.

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

The payment session ID to delete.

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

The user ID making the delete request. Must match the session's userId.

Output

DeletePaymentSessionOutput dataclass

Bases: _SerdeShape

Response structure for deleting a payment session.

Attributes

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.

status instance-attribute
status: str

The status of the deletion. Always DELETED for successful hard delete.