Skip to content

delete_payment_manager

Operation

delete_payment_manager

delete_payment_manager(request: DeletePaymentManagerInput | DeletePaymentManagerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePaymentManagerInputDict]) -> DeletePaymentManagerOutput

Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.

Parameters:

Name Type Description Default
request DeletePaymentManagerInput | DeletePaymentManagerInputDict | 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[DeletePaymentManagerInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeletePaymentManagerOutput

An instance of DeletePaymentManagerOutput.

delete_payment_manager async

delete_payment_manager(request: DeletePaymentManagerInput | DeletePaymentManagerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePaymentManagerInputDict]) -> DeletePaymentManagerOutput

Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.

Parameters:

Name Type Description Default
request DeletePaymentManagerInput | DeletePaymentManagerInputDict | 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[DeletePaymentManagerInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeletePaymentManagerOutput

An instance of DeletePaymentManagerOutput.

Input

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

DeletePaymentManagerInputDict

Bases: TypedDict

Dictionary form of DeletePaymentManagerInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

payment_manager_id instance-attribute
payment_manager_id: Required[str]

The unique identifier of the payment manager to delete.

DeletePaymentManagerInput dataclass

Bases: _SerdeShape

Dataclass for DeletePaymentManagerInput structure.

Attributes

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

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

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

The unique identifier of the payment manager to delete.

Output

DeletePaymentManagerOutput dataclass

Bases: _SerdeShape

Dataclass for DeletePaymentManagerOutput structure.

Attributes

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

The unique identifier of the deleted payment manager.

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 current status of the payment manager, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.