deletePaymentInstrument method

Future<DeletePaymentInstrumentResponse> deletePaymentInstrument({ required String paymentConnectorId, required String paymentInstrumentId, required String paymentManagerArn, String? userId, })

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

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter paymentConnectorId : The payment connector ID. Must match the instrument's paymentConnectorId.

Parameter paymentInstrumentId : The payment instrument ID to delete.

Parameter paymentManagerArn : The payment manager ARN. Must match the instrument's paymentManagerArn.

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

Implementation

Future<DeletePaymentInstrumentResponse> deletePaymentInstrument({
  required String paymentConnectorId,
  required String paymentInstrumentId,
  required String paymentManagerArn,
  String? userId,
}) async {
  final headers = <String, String>{
    if (userId != null)
      'X-Amzn-Bedrock-AgentCore-Payments-User-Id': userId.toString(),
  };
  final $payload = <String, dynamic>{
    'paymentConnectorId': paymentConnectorId,
    'paymentInstrumentId': paymentInstrumentId,
    'paymentManagerArn': paymentManagerArn,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/payments/deletePaymentInstrument',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return DeletePaymentInstrumentResponse.fromJson(response);
}