delete_payment_instrument¶
Operation¶
delete_payment_instrument
¶
delete_payment_instrument(request: DeletePaymentInstrumentInput | DeletePaymentInstrumentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePaymentInstrumentInputDict]) -> DeletePaymentInstrumentOutput
Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeletePaymentInstrumentInput | DeletePaymentInstrumentInputDict | 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[DeletePaymentInstrumentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeletePaymentInstrumentOutput
|
An instance of |
delete_payment_instrument
async
¶
delete_payment_instrument(request: DeletePaymentInstrumentInput | DeletePaymentInstrumentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePaymentInstrumentInputDict]) -> DeletePaymentInstrumentOutput
Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeletePaymentInstrumentInput | DeletePaymentInstrumentInputDict | 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[DeletePaymentInstrumentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeletePaymentInstrumentOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeletePaymentInstrumentInputDict
¶
Bases: TypedDict
Dictionary form of DeletePaymentInstrumentInput.
Attributes¶
payment_connector_id
instance-attribute
¶
The payment connector ID. Must match the instrument's paymentConnectorId.
payment_instrument_id
instance-attribute
¶
The payment instrument ID to delete.
payment_manager_arn
instance-attribute
¶
The payment manager ARN. Must match the instrument's paymentManagerArn.
DeletePaymentInstrumentInput
dataclass
¶
Bases: _SerdeShape
Request structure for deleting a payment instrument.
Attributes¶
payment_connector_id
class-attribute
instance-attribute
¶
payment_connector_id: str | None = ...
The payment connector ID. Must match the instrument's paymentConnectorId.
payment_instrument_id
class-attribute
instance-attribute
¶
payment_instrument_id: str | None = ...
The payment instrument ID to delete.
Output¶
DeletePaymentInstrumentOutput
dataclass
¶
Bases: _SerdeShape
Response structure for deleting a payment instrument.