Skip to content

delete_payment_connector

Operation

delete_payment_connector

delete_payment_connector(request: DeletePaymentConnectorInput | DeletePaymentConnectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePaymentConnectorInputDict]) -> DeletePaymentConnectorOutput

Deletes a payment connector.

Parameters:

Name Type Description Default
request DeletePaymentConnectorInput | DeletePaymentConnectorInputDict | 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[DeletePaymentConnectorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeletePaymentConnectorOutput

An instance of DeletePaymentConnectorOutput.

delete_payment_connector async

delete_payment_connector(request: DeletePaymentConnectorInput | DeletePaymentConnectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePaymentConnectorInputDict]) -> DeletePaymentConnectorOutput

Deletes a payment connector.

Parameters:

Name Type Description Default
request DeletePaymentConnectorInput | DeletePaymentConnectorInputDict | 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[DeletePaymentConnectorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeletePaymentConnectorOutput

An instance of DeletePaymentConnectorOutput.

Input

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

DeletePaymentConnectorInputDict

Bases: TypedDict

Dictionary form of DeletePaymentConnectorInput.

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_connector_id instance-attribute
payment_connector_id: Required[str]

The unique identifier of the payment connector to delete.

payment_manager_id instance-attribute
payment_manager_id: Required[str]

The unique identifier of the parent payment manager.

DeletePaymentConnectorInput dataclass

Bases: _SerdeShape

Dataclass for DeletePaymentConnectorInput 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_connector_id class-attribute instance-attribute
payment_connector_id: str | None = ...

The unique identifier of the payment connector to delete.

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

The unique identifier of the parent payment manager.

Output

DeletePaymentConnectorOutput dataclass

Bases: _SerdeShape

Dataclass for DeletePaymentConnectorOutput structure.

Attributes

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

The unique identifier of the deleted payment connector.

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 connector, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.