delete_payment_instrument¶
Operation¶
async
¶
delete_payment_instrument(input: DeletePaymentInstrumentInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
DeletePaymentInstrumentInput
|
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 |
|---|---|
DeletePaymentInstrumentOutput
|
An instance of |
Input¶
dataclass
¶
Request structure for deleting a payment instrument.
Attributes¶
class-attribute
instance-attribute
¶
payment_connector_id: str | None = None
The payment connector ID. Must match the instrument's paymentConnectorId.
class-attribute
instance-attribute
¶
payment_instrument_id: str | None = None
The payment instrument ID to delete.
class-attribute
instance-attribute
¶
payment_manager_arn: str | None = None
The payment manager ARN. Must match the instrument's paymentManagerArn.
class-attribute
instance-attribute
¶
user_id: str | None = None
The user ID making the delete request. Must match the instrument's userId.
Output¶
dataclass
¶
Response structure for deleting a payment instrument.
Attributes¶
instance-attribute
¶
status: PaymentInstrumentStatus
The status of the instrument after deletion. Always DELETED for successful soft delete.