Skip to content

Deletes a payment instrument

Description

Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.

Usage

bedrockagentcore_delete_payment_instrument(userId, paymentManagerArn,
  paymentConnectorId, paymentInstrumentId)

Arguments

  • userId

    The user ID making the delete request. Must match the instrument's userId.

  • paymentManagerArn

    [required] The payment manager ARN. Must match the instrument's paymentManagerArn.

  • paymentConnectorId

    [required] The payment connector ID. Must match the instrument's paymentConnectorId.

  • paymentInstrumentId

    [required] The payment instrument ID to delete.

Value

A list with the following syntax:

list(
  status = "INITIATED"|"ACTIVE"|"FAILED"|"DELETED"|"BLOCKED"
)

Request syntax

svc$delete_payment_instrument(
  userId = "string",
  paymentManagerArn = "string",
  paymentConnectorId = "string",
  paymentInstrumentId = "string"
)