delete_payment_manager¶
Operation¶
async
¶
delete_payment_manager(input: DeletePaymentManagerInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
DeletePaymentManagerInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
DeletePaymentManagerOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for DeletePaymentManagerInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = 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.
class-attribute
instance-attribute
¶
payment_manager_id: str | None = None
The unique identifier of the payment manager to delete.
Output¶
dataclass
¶
Dataclass for DeletePaymentManagerOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
payment_manager_id: str | None = None
The unique identifier of the deleted payment manager.
instance-attribute
¶
status: PaymentManagerStatus
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.